From aa36adc5fd2e041dedaada4d5c07bd7363a42c3a Mon Sep 17 00:00:00 2001 From: Anthony Lapenna Date: Thu, 2 Aug 2018 09:39:43 +0200 Subject: [PATCH] chore(project): update CONTRIBUTING.md --- CONTRIBUTING.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1af8bc0be..3ddc75e8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Some basic conventions for contributing to this project. -### General +## General Please make sure that there aren't existing pull requests attempting to address the issue mentioned. Likewise, please check for issues related to update, as someone else may be working on the issue in a branch or fork. @@ -13,7 +13,7 @@ When creating a new branch, prefix it with the *type* of the change (see section For example, if you work on a bugfix for the issue #361, you could name the branch `fix361-template-selection`. -### Issues open to contribution +## Issues open to contribution Want to contribute but don't know where to start? @@ -24,14 +24,14 @@ Some of the open issues are labeled with prefix `exp/`, this is used to mark the either AngularJS or Golang * **advanced**: a task that require a deep understanding of the project codebase -You can have a use Github filters to list these issues: +You can use Github filters to list these issues: * beginner labeled issues: https://github.com/portainer/portainer/labels/exp%2Fbeginner * intermediate labeled issues: https://github.com/portainer/portainer/labels/exp%2Fintermediate * advanced labeled issues: https://github.com/portainer/portainer/labels/exp%2Fadvanced -### Commit Message Format +## Commit Message Format Each commit message should include a **type**, a **scope** and a **subject**: @@ -47,7 +47,7 @@ Lines should not exceed 100 characters. This allows the message to be easier to #269 style(dashboard): update dashboard with new layout ``` -#### Type +### Type Must be one of the following: @@ -61,16 +61,30 @@ Must be one of the following: * **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation -#### Scope +### Scope The scope could be anything specifying place of the commit change. For example `networks`, `containers`, `images` etc... You can use the **area** label tag associated on the issue here (for `area/containers` use `containers` as a scope...) -#### Subject +### Subject The subject contains succinct description of the change: * use the imperative, present tense: "change" not "changed" nor "changes" * don't capitalize first letter * no dot (.) at the end + +## Contribution process + +Our contribution process is described below. Some of the steps can be visualized inside Github via specific `contrib/` labels, such as `contrib/func-review-in-progress` or `contrib/tech-review-approved`. + +### Bug report + +![portainer_bugreport_workflow](https://user-images.githubusercontent.com/5485061/43569306-5571b3a0-9637-11e8-8559-786cfc82a14f.png) + +### Feature request + +The feature request process is similar to the bug report process but has an extra functional validation before the technical validation. + +![portainer_featurerequest_workflow](https://user-images.githubusercontent.com/5485061/43569315-5d30a308-9637-11e8-8292-3c62b5612925.png)