Skip to content

coding-guidelines.md

Latest commit

 

History

History
48 lines (37 loc) · 2.59 KB

coding-guidelines.md

File metadata and controls

48 lines (37 loc) · 2.59 KB

Coding Guidelines

Contributors to the Tern Systems GitHub Organization are to detail the degree of changes that were invoked at each commit stage. Maintaining a high level of professionalism in work and communication is paramount to the integrity of the Tern Systems GitHub Organization and so the following guidelines must be followed:

  1. Adhere to the Tern Systems Coding Standards

    • Follow established coding standards and style guides relevant to the Tern Systems GitHub Organization.

    • Ensure consistency in code formatting, naming conventions, and file organization.

  2. Write Comprehensive Documentation

    • Provide clear and concise documentation for all functions, classes, and modules.

    • Maintain an up-to-date README file that includes setup instructions, usage examples, and project overview.

  3. Commit Often with Descriptive Messages

    • Commit code changes frequently to avoid large, unwieldy commits.

    • Use descriptive commit messages that clearly explain the purpose of the changes.

  4. Conduct Thorough Code Reviews

    • Perform rigorous code reviews for all pull requests to ensure code quality and adherence to guidelines.

    • Provide constructive feedback and address all comments before merging code.

  5. Ensure Robust Testing

    • Write comprehensive unit, integration, and end-to-end tests to cover all critical code paths.

    • Use continuous integration (CI) pipelines to run automated tests on every commit and pull request.

  6. Prioritize Security and Performance

    • Implement best practices for security, such as input validation, error handling, and secure authentication.

    • Optimize code for performance, ensuring efficient use of resources and minimal latency.

  7. Maintain Clean and Modular Code

    • Write clean, readable, and maintainable code by following the principles of modularity and separation of concerns.

    • Avoid code duplication and strive for reusability through well-defined interfaces and components.

  8. Use Effective Branching Strategies

    • Adopt a branching strategy such as GitFlow or feature branching to manage development workflows efficiently.

    • Ensure that the main branch remains stable and deployable by merging only thoroughly tested and reviewed code.



By following these guidelines, we ensure that our codebase remains high-quality, maintainable, and efficient, fostering a collaborative and productive development environment.