Skip to content

Contributions

If you have any ideas, just open an issue and share them.

Pull requests

If you'd like to contribute, here are the steps:

  1. Fork the project (https://github.com/steve-lebleu/kompletr.git)
  2. Create your feature branch
bash
> git checkout -b feature/foo
  1. Commit your changes
bash
> git commit -m 'feat: amazing new feature'
  1. Make sure your branch is not behind master
  2. Push your branch
bash
> git push origin feature/foo
  1. Create a new pull request
  2. Pull requests are warmly welcome

Versionning

For transparency and insight into the release cycle, releases will be numbered with the semver standard:

html
<major>.<minor>.<patch>

Following guidelines are relevant:

  • Breaking backwards compatibility bumps the major
  • New additions without breaking backwards compatibility bumps the minor
  • Bug fixes and misc changes bump the patch

Release flags

  • [Experimental]: under testing and might be deprecated at any point
  • [Deprecated]: not developed / supported anymore, might be removed at any point
  • [Removed]: completely gone, no longer exists
  • [Changed]: breaking change in the API or the core library
  • [Updated]: non-breaking change in the API or the core library
  • [Fixed]: bug or issue that was fixed and no longer exists
  • [Added]: new feature

Commits flags

🔗 Conventional commits

Released under the GPL License.