If you have any ideas on how to improve this project, feel free to contribute! First create a fork of the project and create a new branch with the feature you want to add. After that, open a pull request and wait for the review. You can also open a issue with the "enchantment" label.
Bellow you can see a quick guide:
- Fork the project
- Clone the forked project (
git clone <URL>) - Create a new branch (
git checkout -b feature/feature-name) - Commit your changes (
git commit -m 'feat: Add new feature') - Push to the branch (
git push origin feature/feature-name) - Create a new Pull Request
You can create new badges directly on the official shields.io site by following their documentation.
When you have created your personalized badge and want it to be added to the badge library, follow these steps below
- Fork the project
- Clone the forked project (
git clone <URL>) - Add the badge to the
src/consts/badges.jsonwith the name, url and markdown codeq - Create a new branch (
git checkout -b badge/badge-name) - Commit your changes (
git commit -am 'Add new badge-name badge') - Push to the branch (
git push origin badge/badge-name) - Create a new Pull Request
- Check the open issues before opening a PR, if you think you can solve it and there are no other PR already open, use
#issue-numberin your commit so that it is added to the issue. It doesn't hurt to leave a comment so that it is known which PR is being used for the issue. - See if any PR is already open for the same issue, if so, try to help in the review process, comments or or bringing changes.
- Keep your commits clean and descriptive using the Conventional Commits pattern to commit your changes.
- Follow the project's code conventions.
- Install the recommended vscode extensions to help you with the code conventions.
Thanks for contributing! 🚀