diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f7b9c59 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,95 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to this project! We welcome contributions from the community. Please read the following guidelines to help us maintain a high standard and streamline the contribution process. + +## How to Contribute + +1. **Fork the Repository** + + - Click the 'Fork' button at the top right of this repository page to create your own copy. + +2. **Clone Your Fork** + + - Clone your forked repository to your local machine: + ```bash + git clone https://github.com//ElixirV3.git + cd ElixirV3 + ``` + +3. **Create a New Branch** + + - Create a branch for your feature or bugfix: + ```bash + git checkout -b + ``` + +4. **Make Your Changes** + + - Make your changes or additions. Please ensure your code follows the existing style and conventions. + +5. **Test Your Changes** + + - Run the application and ensure your changes work as expected and do not break existing functionality. + +6. **Commit Your Changes** + + - Use clear and descriptive commit messages. Follow the commit message format below. + +7. **Push to Your Fork** + + - Push your branch to your forked repository: + ```bash + git push origin + ``` + +8. **Open a Pull Request** + - Go to the original repository and open a pull request. Provide a clear description of your changes and reference any related issues. + +## Commit Message Format + +``` + | (): +``` + +### Examples + +``` +GFG | feat(event): new card designs +GFG | fix(event): api request improve +GFG | chore(event): title copy change +GFG | refactor(event): mentor's search logic + +ELX | feat(event): new card designs +GDG | fix(event): api request improve +CC | chore(event): title copy change +``` + +- ``: Team code. If you are a member of one of the Elixir clubs, use your club's code: + + - `GFG` for GeeksforGeeks ABESEC + - `GDG` for Google Developer Group ABESEC + - `CC` for CodeChef ABESEC + - `ELX` for external contributers + +- ``: Type of change (feat, fix, chore, refactor, etc.) +- ``: Area affected (e.g., event) +- ``: Short summary of the change + +## Code Style & Standards + +- Follow the existing code style and formatting. +- Write clear, concise, and well-documented code. +- Add comments where necessary, especially for complex logic. +- Write tests for new features or bug fixes if applicable. + +## Community Standards + +- Be respectful and inclusive in all interactions. +- Provide constructive feedback in code reviews. +- Report issues or bugs using the issue tracker. + +## Need Help? + +If you have any questions or need guidance, feel free to open an issue or reach out to the maintainers. + +Thank you for contributing!