You can contribute to Make Badges in various ways, including:
- Reporting bugs or issues on GitHub. Please make sure to include fill in all the details in the issue template to make sure the issue can be addressed as quickly as possible.
- Looking at existing issues and adding more information, particularly helping to reproduce the issues.
- Submitting a pull request with a bug fix or an improvement.
The master branch of the repository should be kept releasable at any time. This way we can continuously deploy fixes and improvements without costly managing of different branches and issues will be noticed and fixed quickly. This also ensures other contributors can check out the latest version from GitHub and work on it with minimal disruption from other features in progress.
Keeping the master releasable means that changes merged to it need to be:
- Non-breaking: If code that is unreleasable or fails the test suite ends up in master, it should be reverted.
- Tested: Always include a test plan in pull requests. Do not merge code that doesn't pass all automated tests.
Please read these Steps to Contribute & get an Understanding of A Good Commit Message
- Fork the repository and create a feature branch. (Existing contributors can create feature branches without forking. Prefix the branch name with
@your-github-username/.) - Clone the Forked Repository.
- You can then run
yarn startin the root folder to start watching and automatically re-building packages when there are new changes.
To submit a pull request:
- Write the description of your pull request. Make sure to include a test plan and test your changes.
- Make sure all tests pass on -TESTING PLATFORM-.
- Wait for a review and adjust the code if necessary.