Skip to content

Commit ca64c41

Browse files
committed
docs: enhance CONTRIBUTING guide
Signed-off-by: Maximillian Arruda <[email protected]>
1 parent 4c6d69b commit ca64c41

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,28 @@ Try to explain the scenario to us by following these tips:
9090
- **Context:** explain the conditions which led you to write this issue.
9191
- **Problem or idea:** the context should lead to something, an idea or a problem that you’re facing.
9292
- **Solution or next step:** this where you move forward. You can engage others (request feedback), assign somebody else to the issue, or simply leave it for further investigation, but you absolutely need to propose a next step towards solving the issue.
93+
94+
== Contribute to the repo
95+
96+
To contribute to the repo one must adhere to the following:
97+
98+
**Types of Commits:**
99+
100+
- **fix:** Any commit that patches a bug anywhere in the codebase
101+
- **feat:** Any commit that introduces a new feature or focuses on enhancing the scope of exisiting features
102+
- **breaking changes:** Any commit that has a footer "BREAKING CHANGE", or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
103+
- **other than fix and feat:** Any commit that consists of the following keywords: build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. For other keywords refer to https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional[@commitlint/config-conventional] (based on the Angular convention)
104+
- **other footers:**<description> may be provided and follow a convention similar to https://git-scm.com/docs/git-interpret-trailers[git trailer format]
105+
106+
**Examples of commits**
107+
108+
- **Regular Commit Message:** This may be used for either fix or feat and can be wriiten as "fix:<message>" or "feat:<message>"
109+
- **Commit with breaking change**: Example: A new feature being introduced as a breaking change can be written as "feat!:<message>", this can also simply be written as a regular feat with the "BREAKING CHANGE" appended to it at the end of the commit
110+
- **Specific breaking change:**: Example: A breaking change introduced with a new feature somewhere in the api can be written as "feat(api)!:<message>"
111+
- **Changing the docs:** "docs:<message>"
112+
- **Regular commit message with specificaton:** A new feature introduced in the api can be written as "feat(api):<message>"
113+
114+
**Formatting Commit messages**
115+
116+
All commit messages must clearly state the change that takes place. Multiple paragraphs or bullet points explaining the changes in detail are encouraged. The message must contain the link to the issue that it is directed towards.
117+
If there are other people working on a particular issue which you wanted to work on as well, consider working together. If the commit influences a visual change, screenshots are encouraged

0 commit comments

Comments
 (0)