From 640d70afa0da2cb72c231e6f759b9f57c4f53f65 Mon Sep 17 00:00:00 2001 From: Andrey Melnikov Date: Tue, 2 Jun 2020 13:48:27 -0700 Subject: [PATCH 1/2] update: contributing with info on PRs --- docs/getting-started/contributing.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index fc236aba..dec97a36 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -29,6 +29,31 @@ We welcome all contributions and follow these highlights from [Google developer Our documentation site is built on [Docusaurus](https://v2.docusaurus.io/). +## Commits + +All commits should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) as closely as possible. + +## Pull Requests + +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 + +An example is: + +``` +fix: issue where workspace page crashed upon three refreshes. +``` + +* Add the appropriate /kind label (enhancement, bug, etc) +* Set the milestone + ## Project repositories Onepanel consists of the following repositories. See `CONTRIBUTING.md` file in each repository for more information. From dbef45c945808c4de8a77cb258080878baee97e5 Mon Sep 17 00:00:00 2001 From: Andrey Melnikov Date: Tue, 2 Jun 2020 14:51:08 -0700 Subject: [PATCH 2/2] update: cleaned up wording around /kind label and removed setting the milestone because external users can not set that. --- docs/getting-started/contributing.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index dec97a36..ee8c12f8 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -51,8 +51,7 @@ An example is: fix: issue where workspace page crashed upon three refreshes. ``` -* Add the appropriate /kind label (enhancement, bug, etc) -* Set the milestone +* 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.