Welcome to our GitHub repository! Before you start making any changes or adding new features to the project, please follow the instructions below to ensure smooth collaboration and maintain a well-organized codebase.
-
Discussion in Group: Before starting any major development or making significant changes, create a discussion within the project group. This discussion should include a detailed description of the proposed changes or new features. This step is crucial to gather feedback and ensure everyone is on the same page.
-
Issue Tracking: After the group discussion, create an issue on GitHub describing the changes or features you plan to implement. This will serve as a reference point for discussion and act as a central place for tracking the progress of the proposed changes.
-
Fork the Repository: If you are not a direct collaborator, start by forking this repository to your GitHub account.
-
Branch Naming Convention: When working on a new feature or bug fix, always create a new branch with a descriptive name. Use the following format for branch names:
feature/your-feature-name bugfix/issue-number -
Code Review: Before pushing your changes to the repository, ensure that your code is clean, well-documented, and adheres to the project's coding guidelines. A code review is encouraged to maintain code quality.
-
Pull Request: When your changes are ready for review, open a pull request from your branch to the main repository's
mainbranch. Make sure to reference the issue related to your changes in the pull request description. -
Review and Merge: Your pull request will be reviewed by one or more project maintainers. If there are any required changes or suggestions, address them accordingly. Once the changes are approved, your branch will be merged into the main repository.
-
Follow the programming language conventions and best practices used in the project.
-
Write clear and concise code with meaningful variable and function names.
-
Comment your code when necessary to improve readability and understanding.
-
Ensure your code is formatted properly and free of linting errors.
If you have any questions, concerns, or need help with anything related to the project, don't hesitate to reach out to the project maintainers or post your questions in the project group chat.
Include the appropriate license information here. If you haven't decided on a license yet, it's essential to select an open-source license that aligns with the project's goals and intentions.
Thank you for contributing to our project! Your efforts and contributions are greatly appreciated. Let's collaborate and make this project even better!