Code Conventions

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119

Priority values

Estimation values

If estimation exceeds 2 weeks, an issue MUST be split into smaller ones.

Repository rules

Branch rules






Issue rules

Pull request rules

Code formatting rules

Additional Code Conventions

Indenting: 4 spaces MUST be used.

Descriptive Names: Use descriptive names for functions or classes.

Comments: Avoid comments in the code; aim for self-explanatory code.

Language Conventions: Follow language code conventions style.

KISS Principle: Always try to Keep It Simple (KISS).

DRY Principle: Don’t Repeat Yourself (DRY) when you have more than 3 repeats.

Library Usage: Do not write a new version; search if it already exists and learn how to use it (we don’t need another JS JSON library).

Testing: It always nice when a project has some unit tests, or other types of tests. So atleast unit tests are required, and MUST cover as many as possible.

Documentation: Emphasize the importance of good documentation. Every repository, module, class, and method should have clear and concise documented.

Versioning: In alignment with best practices, we follow Semantic Versioning (SemVer) for our software projects.

Code Ownership: Always clarify the concept of code ownership. Know for what part you are responsible to. Specify who is responsible for maintaining different parts of the codebase.

Continuous Integration (CI) and Continuous Deployment (CD): Outline CI/CD practices, including automated testing, deployment pipelines, and versioning strategies. Always try to automate.

Accessibility and Internationalization: If applicable, include guidelines for making your software accessible and supporting internationalization (i18n) and localization (l10n).

Community Guidelines: If your project involves an open-source community, include guidelines for community contributions, issue reporting, and code of conduct.

#text   #docs   #help   #guide  

Reply to this post by email ↪