From db61f3bdbdc9f5a1eccbefa645e0e47316b115d9 Mon Sep 17 00:00:00 2001 From: Andrey Melnikov Date: Tue, 2 Jun 2020 15:00:00 -0700 Subject: [PATCH 1/3] update: add a list for the PR requirements and sections for more detailed information. --- docs/getting-started/contributing.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index ee8c12f8..d802a0b5 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -37,7 +37,14 @@ All commits should follow [Conventional Commits](https://www.conventionalcommits When making a pull request, -* Prefix the name with +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 @@ -51,7 +58,10 @@ An example is: fix: issue where workspace page crashed upon three refreshes. ``` -* Add the a /kind label in your PR description (enhancement, bug, etc) +### Add a /kind label + +A /kind label helps further identify what the pull request is for + ## Project repositories Onepanel consists of the following repositories. See `CONTRIBUTING.md` file in each repository for more information. From 2d3b467dc318a186ad61a0c425a23fef9e4cbd8d Mon Sep 17 00:00:00 2001 From: Andrey Melnikov Date: Tue, 2 Jun 2020 15:02:29 -0700 Subject: [PATCH 2/3] update: added \kind types --- docs/getting-started/contributing.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index d802a0b5..8012e9e8 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -45,23 +45,35 @@ When making a pull request, 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 + * **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 +``` + ## Project repositories Onepanel consists of the following repositories. See `CONTRIBUTING.md` file in each repository for more information. From 2c09bac1a581d4cb9c395da224becf4dce59554b Mon Sep 17 00:00:00 2001 From: Andrey Melnikov Date: Tue, 2 Jun 2020 15:27:02 -0700 Subject: [PATCH 3/3] fix: \ -> / --- docs/getting-started/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index 8012e9e8..9e7ecc90 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -71,7 +71,7 @@ The types are An example is: ``` -\kind enhancement +/kind enhancement ```