-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1 parent
188c5b9
commit a11ba04
Showing
1 changed file
with
49 additions
and
16 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 |
---|---|---|
@@ -1,39 +1,72 @@ | ||
# Contributing to Phonebook | ||
# Contributing to Phonebook | ||
|
||
## How can I contribute? | ||
|
||
### Reporting Bugs | ||
|
||
You can contribute by reporting bugs. For that there are some rules: | ||
|
||
- Before submitting please check that the same issue was not already submitted. | ||
- Use the [Bug-Report-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and answer the questions. | ||
- Use the | ||
[Bug-Report-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=bug&template=bug_report.md&title=) | ||
and answer the questions. | ||
|
||
### Suggesting new Features | ||
If you have new ideas or have something that you really need in Phonebook you can submit a new feature request. For that there are some rules: | ||
- Before submitting please check that the same feature request was not already submitted. | ||
- Use the [Feature-Request-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=feature&template=feature_request.md&title=) and answer the questions. | ||
|
||
If you have new ideas or have something that you really need in Phonebook you | ||
can submit a new feature request. For that there are some rules: | ||
|
||
- Before submitting please check that the same feature request was not already | ||
submitted. | ||
- Use the | ||
[Feature-Request-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=feature&template=feature_request.md&title=) | ||
and answer the questions. | ||
|
||
### Your First Code Contribution | ||
Unsure where to begin contributing to Phonebook? You can start by looking for the ["good-first-issue"-label](https://github.com/T-Systems-MMS/phonebook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). | ||
If you have questions about the issue or do not know where to start you can just ask under the issue. | ||
|
||
Unsure where to begin contributing to Phonebook? You can start by looking for | ||
the | ||
["good-first-issue"-label](https://github.com/T-Systems-MMS/phonebook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). | ||
If you have questions about the issue or do not know where to start you can just | ||
ask under the issue. | ||
|
||
### Open Pull Requests | ||
If you want to open a pull request please use our [template](will be added soon). Please also note the issue which get resolved and stuff the reviewers need to know before reviewing your code. | ||
|
||
If you want to open a pull request please use our [template](will be added | ||
soon). Please also note the issue which get resolved and stuff the reviewers | ||
need to know before reviewing your code. | ||
|
||
## What should I know before I get started? | ||
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. | ||
|
||
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. | ||
|
||
### Mandatory stuff | ||
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/). | ||
|
||
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/). | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
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). | ||
|
||
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). | ||
The messages should have the following format: `type(scope): subject` | ||
|
||
- *type* -> feat, fix, chore and docs\ | ||
- *scope* -> The part of the program which will be affected \ | ||
- *subject* -> Description of what has been changed\ | ||
- _type_ -> feat, fix, chore and docs\ | ||
- _scope_ -> The part of the program which will be affected \ | ||
- _subject_ -> Description of what has been changed\ | ||
|
||
## Additional Notes | ||
|
||
### Issue and Pull request labels | ||
qualified: You can find additional information of what you need to do to solve this issue. | ||
good-first-issue: This Label represents problems with a lower complexity and a good way to start into the project. | ||
|
||
qualified: You can find additional information of what you need to do to solve | ||
this issue. good-first-issue: This Label represents problems with a lower | ||
complexity and a good way to start into the project. |