From 49709f048ce6d345a42b2d2e194433cc14f2d2a0 Mon Sep 17 00:00:00 2001 From: Kirill Date: Fri, 5 Jan 2024 14:45:54 +0100 Subject: [PATCH] docs(.github/contrib): add commits and PR styleguide to contribmd (#3634) Co-authored-by: Diego Romero --- .github/CONTRIBUTING.md | 44 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index db98c89722..23e9936d9e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -121,6 +121,50 @@ func TestLargeStringTest(t *testing.T) { } ``` + +## PR & Commit Standards +The purpose of this section is to outline the standard naming conventions approved by the Gossamer team for Pull Requests and commit messages. The reasoning is to have improved understanding and auto generated changelogs for releases. + +### PR and final commit message should follow: + +`**TYPE:[SCOPE]: brief description**` + +**TYPEs**: + +- **fix** = patches a bug or a resolves a particular issue +- **feat** = introduces new functionality +- **chore** = regular code maintenance +- **docs** = anything related to documentation +- **style** = updates related to styling (e.g. logs) +- **test** = anything related to tests +- **refactor** = refactoring a section of the code base + +**[SCOPE]** + +- name of primary package that changes were introduced (e.g. lib/runtime) + +### Example PR names: + +- fix(dot/rpc): fixed return type for chain head + +- feat(dot/rpc): Add support for submit and watch extrinisic + +- docs: Updated usage section for running a gossamer node + +- tests(lib/runtime): Added additional test coverage for allocator + +- chore(lib/runtime): Bumped wasmer to 1.0 + +- style(cmd/gossamer): Updated CLI arguments format + +- refactor(lib/trie): Refactored how trie is pruned + + +> For improved Git commit messages refer to: +> https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/ + + + ## Contributor Responsibilities We consider two types of contributions to our repo and categorize them as follows: