This project code is intended to be...
- Clean. Keep it well formatted and follow your favourite language conventions, so one can understand it.
- Documented. Keep it well documented, so one can learn from it.
- Reusable. Keep it cohese and modular, with as little responsibility per programming unit (function, method, class, module, project), as possible, so one can reuse it.
- Testable. Keep it easy to debug and test, so one can be confident that it works properly.
This project follows gitflow organizational style for standardized contribution and it has a gitmoji inspired commit styling to improve messages semantics.
| Emoji | Code | Type |
|---|---|---|
| 📝 | : memo : | Adds documentation |
| ✨ | : sparkles : | Adds complete feature |
| 🚧 | : construction : | Adds partial feature |
| ✅ | : white_check_mark : | Adds tests |
| 🔧 | : wrench : | Adjusts settings |
| 🐛 | : bug : | Bugfix |
| 🚀 | : rocket : | Deploys code |
| 🐳 | : whale : | Adjusts settings |
| ⬇️ | : arrow_down : | Downgrades dependencies |
| 🎉 | : tada : | First commit |
| 🚑 | : ambulance : | Hotfix |
| 🎨 | : art : | Improves code |
| ⚡ | : zap : | Improves performance |
| 🔒 | : lock : | Improves security |
| 🔥 | : fire : | Removes code or files |
| ⬆️ | : arrow_up : | Upgrades dependencies |
This project is intended to be changed via...
- Fork. Fork it into your account and make desired changes.
- Pull Requests. Sincronize your repository and open a pull request to the original repository.
Something is wrong, missing or doesn't follow the guidelines? Please, don't hesitate to contact me and address the issue. I will be more than pleased to improve the project, the rules and even myself.