diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index ee8c12f8..9e7ecc90 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -37,21 +37,43 @@ All commits should follow [Conventional Commits](https://www.conventionalcommits When making a pull request, -* Prefix the name with - * **fix** - fixing something - * **feature** - adding a feature - * **clean** - cleaning up code - * **chore** - something mundane like updating a version number - * **docs** - updating documents - * **tests** - adding tests +1. Prefix the name with the type of commit (fix, feature, docs, etc) +2. Add a /kind label in the description (enhancement, bug, etc) + + +### Prefix the name with the type + +The types are + + * **fix** - fixing something + * **feature** - adding a feature + * **clean** - cleaning up code + * **chore** - something mundane like updating a version number + * **docs** - updating documents + * **tests** - adding tests An example is: ``` -fix: issue where workspace page crashed upon three refreshes. +fix: issue where workspace page crashed upon three refreshes +``` + +### Add a /kind label + +A /kind label helps further identify what the pull request is for + +The types are + + * bug + * enhancement + * docs + +An example is: + +``` +/kind enhancement ``` -* Add the a /kind label in your PR description (enhancement, bug, etc) ## Project repositories Onepanel consists of the following repositories. See `CONTRIBUTING.md` file in each repository for more information.