Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.01 KB

GUIDELINES.md

File metadata and controls

34 lines (21 loc) · 1.01 KB

General Guidelines

Rules

Documentation

  • Every repo should contain an updated readme file. We expect the following sections in the Readme:

    1. Project description
    2. Installation: Explain how users can install or use your project locally on their computers. Include code snippets if necessary.
    3. Describe how to use your project, including code examples or screenshots.

Code

  • Use descriptive naming of variables, functions and classes
  • Avoid duplicating code by creating reusable functions or modules.
  • All code and comments should be written in English.

Security

  • Avoid hardcoding sensitive information like passwords or API keys; use environment variables or secure vaults.
  • Avoid exposing sensitive information in error messages.

Testing

  • Write unit tests for critical parts of your code
  • Separate source code from testing code in different folders

Logging

  • Log messages should be clear and should provide enough context to understand the issue.
  • Log messages should be in English