-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[#3] Add Default coding guidelines and CODEOWNERS
- Loading branch information
1 parent
9ef3bd8
commit e585bcf
Showing
5 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 @@ | ||
* @Oztechan/core-team |
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 @@ | ||
addAssignees: author |
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,49 @@ | ||
# Contributing | ||
|
||
## Branch | ||
|
||
Branch name should start with `ISSUE_ID` and after the id there should be `-` then continues with description of branch or title of ticket. Use `_` for empty spaces. | ||
|
||
Example: | ||
|
||
``` | ||
123-My_Cool_Feature_Or_Bug | ||
``` | ||
|
||
## Commit Message | ||
|
||
Every commit message should match the following format `[Oztechan/TraceFit#ISSUE_ID] Commit message` | ||
|
||
Example: | ||
|
||
``` | ||
[Oztechan/TraceFit#123] My cool feature | ||
``` | ||
|
||
## Pull Request | ||
|
||
### Title | ||
|
||
Pull Request title should follow below format: | ||
|
||
``` | ||
[Oztechan/TraceFit#ISSUE_ID] ISSUE_TITLE | ||
``` | ||
|
||
Example: | ||
|
||
``` | ||
[Oztechan/TraceFit#ISSUE_ID] Whatever the name of ticket is | ||
``` | ||
|
||
### Description | ||
|
||
Description has to have `Resloves Oztechan/TraceFit#ISSUE_ID` with relevant issue. It will help automatically close relevant issue once the PR is merged. | ||
|
||
Example: | ||
|
||
``` | ||
Resolves Oztechan/TraceFit#123 | ||
Some description. | ||
``` |
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,7 @@ | ||
## Description | ||
|
||
<!-- | ||
Issue Checklist | ||
1. I have added a valid description. | ||
2. If it is a bug, I have added how to reproduce it. | ||
--> |
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,11 @@ | ||
## Description | ||
|
||
Resolves Oztechan/TraceFit* | ||
<!-- | ||
Pull Request Checklist | ||
1. I have read the https://github.com/Oztechan/TraceFit/blob/develop/docs/CONTRIBUTING.md | ||
2. PR title in the format of `[Oztechan/TraceFit#ISSUE_ID] ISSUE_TITLE` | ||
3. I have added a valid description and | ||
4. I replaced `*` with the link of the issue. Ie `#123` into description (it will automatically close issue once PR is merged) | ||
4. I have tested the app before creating this PR | ||
--> |