Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 3.2 KB

collaboration.rst

File metadata and controls

87 lines (59 loc) · 3.2 KB

Collaboration Guidelines

Welcome to the collaborative development process at GoDjango LLC. This document outlines the guidelines and best practices to ensure smooth and effective collaboration on our GitHub repositories.

Version Control

  1. Branching Strategy: - Use feature branches for developing new features or fixing bugs. - Naming convention: feature/your-feature-name, bugfix/issue-number, etc.
  2. Pull Requests: - Create a pull request for each feature or bug fix. - Provide a clear and concise title and description. - Reference relevant issues in the description. - Reviewers should be assigned for every pull request.
  3. Code Reviews: - All changes must go through a code review process. - Address and resolve review comments before merging. - Use inline comments for specific feedback.

Coding Standards

  1. Coding Style(Per language):
    • Python: Follow the coding style and conventions defined in style guide.
    • JS, JSX, or TS: Follow the coding style and conventions defined in eslint style guide.
    • C: Follow the coding style and conventions defined in GNU Style guide.
    • Others included in Google standards: Follow the coding style and conventions defined in google style guide (The above style guides overwrite these ones, i.e.: python).
  2. Commit Messages: - Write clear and descriptive commit messages. - Use present tense ("Add feature" not "Added feature"). - Reference relevant issues in commit messages.
  3. Documentation: - Keep code and project documentation up-to-date. - Use docstrings and comments where necessary.

Issue Tracking

  1. Creating Issues: - Use GitHub issues to report bugs, request features, or discuss improvements. - Provide a clear and concise title and description. - Use labels to categorize issues.
  2. Closing Issues: - Reference the closing keyword in commit messages to close related issues automatically (e.g., "Closes #123").

Collaboration Etiquette

  1. Communication: - Use GitHub discussions for non-code discussions. - Be respectful and constructive in comments and discussions.
  2. Merging: - Avoid force pushes to branches that others are working on. - Ensure that the build is passing before merging.
  3. Continuous Integration: - Set up and configure CI/CD pipelines for each repository. - Ensure that all tests pass before merging.

Security

  1. Security Vulnerabilities:
    • Report security vulnerabilities privately through [email protected].
    • Do not disclose security-related information in public discussions.

We aim to maintain a clean, organized, and collaborative development environment by following these guidelines. If you have any questions or suggestions for improvement, feel free to open a discussion or contact us.

Thank you for your contribution!