mirror of
https://github.com/inttter/md-badges.git
synced 2026-05-06 10:26:57 +02:00
58 lines
2.2 KiB
Markdown
58 lines
2.2 KiB
Markdown
# 🛠️ 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 📕
|
|
|
|
### Pull Request Guidelines
|
|
|
|
Please ensure your pull request adheres to the following guidelines:
|
|
|
|
- Make sure your badge isn't a duplicate.
|
|
|
|
- They should be added in the correct category.
|
|
|
|
- If it fits into none of the categories already there, you are welcome to create a new category.
|
|
- Make sure the category + badge is placed in the correct alphabetical order.
|
|
|
|
- Make sure your links work.
|
|
|
|
- Use the same format as already used in the code:
|
|
|
|
> existing content...
|
|
|
|
| Preview | Markdown Code |
|
|
|---------|---------------|
|
|
[](#) | `[](#)`
|
|
|
|
**(essentially duplicating the Preview/Markdown code into two sections, one without the ` and one with it)**
|
|
|
|
# ⚖️ License ⚖️
|
|
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](LICENSE) file.
|