-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): add contribution guidelines
- Loading branch information
1 parent
3f99f1d
commit 63f22e1
Showing
2 changed files
with
25 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Contributing | ||
|
||
## How to contribute code | ||
|
||
### Commit messages | ||
|
||
This project uses [semantic-release](https://github.com/semantic-release/semantic-release) to automatically release when changes are merged to `main`. | ||
|
||
In order for this to work, commit messages must use [Angular Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format), which in the simplest form looks like `<type>: <short summary>`. Below are some examples: | ||
|
||
- `feat: added new component` | ||
- `fix: fixed a bug` | ||
- `docs: updated documentation` | ||
|
||
If your change is a breaking change, this must be stated in the message, for example: | ||
|
||
``` | ||
feat: updated some component | ||
BREAKING CHANGE: removes the '.subcomponent' class. | ||
``` | ||
|
||
### What is a breaking change? | ||
|
||
A breaking change is any "incompatible API change". In the context of this design system, the API consists of CSS classes and SASS variables/functions/mixins etc. Any change which removes or renames a part of the API must be labelled a breaking change. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters