+ 🛠️ Added contributing guide (#32)

This commit is contained in:
Inter 2023-12-10 22:15:24 +00:00
parent 31d0052937
commit e6214fd48d

43
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,43 @@
# 🛠️ Contributing to md-badges 🛠️
Thank you for considering contributing to this project! Whether it's reporting bugs, submitting feature requests, your help is much appreciated.
To contribute to this project, please follow the guidelines outlined below:
# ✨ Ways to Contribute ✨
Reporting Bugs: If you encounter any issues or unexpected behavior, please [open an issue](https://github.com/inttter/md-badges/issues).
Feature Requests: For new features or enhancements, please open an issue or a pull request to suggest your ideas.
# 📃 Code Contributions 📃
Feel free to fork the repository and create a pull request for your proposed changes or fixes. Ensure that the code aligns with the project's standards and guidelines.
# 🏁 Getting Started 🏁
Before you start contributing, follow these steps:
1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your contributions: git checkout -b feature/your-feature.
4. Make your changes and ensure they follow the coding standards and guidelines.
5. Commit your changes: git commit -m '{insert a commit message here}'.
6. Push to your branch: git push origin feature/{name}.
7. Create a pull request to the main repository.
# 📕 Pull Request Guidelines 📕
When submitting a pull request, please follow these guidelines:
1. Provide a clear title and description for your pull request.
2. Explain the changes made and why they are necessary.
3. Ensure your code follows the structure of the rest of the code.
- [See the raw README code for an idea of the structure.](https://github.com/inttter/md-badges/blob/main/README.md?plain=1)
# ⚖️ License ⚖️
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](LICENSE) file.