-
Notifications
You must be signed in to change notification settings - Fork 13
Create contributing guideline #434
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mschwrdtnr
wants to merge
4
commits into
master
Choose a base branch
from
contributing-guideline
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,40 @@ | ||
| # 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. | ||
|
|
||
mschwrdtnr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### 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. | ||
|
|
||
| ### 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. | ||
|
|
||
| ### 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. | ||
|
|
||
| ## What should I know before I get started? | ||
mschwrdtnr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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/). | ||
|
|
||
| ## 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). | ||
| 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\ | ||
|
|
||
| ## 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.