Skip to content

Commit 5a9e7d3

Browse files
authored
git commit message + change direction
1 parent 5165225 commit 5a9e7d3

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

docs/CONTRIBUTING.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
# Contributing to Phonebook
2-
3-
## What should I know before I get started?
4-
Before you start contributing be sure that you have already taken a look at our [Documentation](https://t-systems-mms.github.io/phonebook/). There you can find all things you need to know before work with the project.
5-
6-
### Mandatory stuff
7-
To provide good code quality we are using prettier to format all files the same way. Just make sure that you are using the Plugin [Prettier](https://prettier.io/) in your IDE. You can find our settings [here](https://prettier.io/).
1+
# Contributing to Phonebook
82

93
## How can I contribute?
104
### Reporting Bugs
@@ -22,13 +16,29 @@ Unsure where to begin contributing to Phonebook? You can start by looking for th
2216
If you have questions about the issue or do not know where to start you can just ask under the issue.
2317

2418
### Open Pull Requests
19+
If you want to open a pull request please use our [template](will be added soon).
2520

2621
### Reviewing a pull request
2722

23+
## What should I know before I get started?
24+
Before you start contributing be sure that you have already taken a look at our [Documentation](https://t-systems-mms.github.io/phonebook/). There you can find all things you need to know before work with the project.
25+
26+
### Mandatory stuff
27+
To provide good code quality we are using prettier to format all files the same way. Just make sure that you are using the Plugin [Prettier](https://prettier.io/) in your IDE. You can find our settings [here](https://prettier.io/).
28+
2829
## Styleguides
2930
### Git Commit Messages
31+
Because of we are using [semantic release](https://github.com/semantic-release/semantic-release) it is important that the git messages, especially the merge messages, follow the [Angular commit Message Convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
32+
The messages should have the following format: `type(scope): subject`
33+
34+
> *type* -> feat, fix, chore and docs\
35+
> *scope* -> The part of the program which will be affected \
36+
> *subject* -> Description of what has been changed\
3037
3138
## Additional Notes
3239
### Issue and Pull request labels
40+
tbd..
3341

3442
### Explanation of label "prio"
43+
We have 5 different labels to show the importance of an issue.
44+
tbd..

0 commit comments

Comments
 (0)