When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
The project is actually adopting the following commit emoji legend:
| Commit Type | Emoji |
|---|---|
| Initial Commit | 🎉 Party Popper |
| Version Tag | 🔖 Bookmark |
| New Feature | ✨ Sparkles |
| Bugfix | 🐛 Bug |
| Refactoring | ♻️ Black Universal Recycling Symbol |
| Documentation | 📚 Books |
| Performance | 🐎 Horse |
| Tooling | 🔧 Wrench |
| Tests | 🚨 Police Cars Revolving Light |
| Deprecation | 💩 Pile of Poo |
| Removal | 🗑️ Wastebasket |
| Work In Progress (WIP) | 🚧 Construction Sign |
This was inspired by this repository.
Make sure that every new feature, bugfix or refactoring is correctly under unit tests coverage.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.