Skip to content

Commit

Permalink
[#3] Add Default coding guidelines and CODEOWNERS
Browse files Browse the repository at this point in the history
  • Loading branch information
mustafaozhan committed Oct 30, 2023
1 parent 9ef3bd8 commit e585bcf
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Oztechan/core-team
1 change: 1 addition & 0 deletions .github/auto_assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
addAssignees: author
49 changes: 49 additions & 0 deletions docs/CONTRIBUTING.md
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.
```
7 changes: 7 additions & 0 deletions docs/ISSUE_TEMPLATE.md
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.
-->
11 changes: 11 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
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
-->

0 comments on commit e585bcf

Please sign in to comment.