From 1aaefd7756a0fa6866da1fdd7c6eb54ab67cff8e Mon Sep 17 00:00:00 2001 From: Mohammad Zaki Date: Tue, 19 Mar 2024 12:41:32 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5852a59 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing Guidelines + +Thank you for considering contributing to our project! We appreciate your efforts to make it better. To ensure smooth collaboration, please follow these guidelines: + +## Getting Started + +1. Fork the repository on GitHub. +2. Create a new branch from the `main` branch to work on your changes. + +## Making Changes + +- Before committing any changes, ensure that all test cases pass to verify the integrity of the code. +- Commit your changes with clear and descriptive commit messages. +- Push your changes to your forked repository. + +## Pull Request + +- After pushing your changes to your branch, raise a pull request (PR) to merge your changes into the main repository. +- Provide a detailed description of your changes in the PR description. +- Mention any related issues or reference the relevant discussions if applicable. + +## Code Quality + +- Check for any lint errors on GitHub after committing and pushing your changes. +- Resolve any identified lint errors promptly to maintain code quality standards. + +## Code Review + +- Once all tests pass and there are no lint errors, the code review process will begin. +- Be open to feedback and address any comments or suggestions provided during the review process. + +## Additional Notes + +- Please follow the coding conventions and style guidelines established in the project. +- Document any new features or significant changes you introduce. +- Respect the existing codebase and strive to maintain its coherence and consistency. +- Use Proper Commit Messages to showcase your changes. + +Thank you for your contributions!