Skip to content

Commit

Permalink
[Oztechan/Global#4] Global config update created local 'docs/' from r…
Browse files Browse the repository at this point in the history
…emote 'docs/'
  • Loading branch information
mustafaozhan committed Nov 25, 2023
1 parent 0a96a28 commit f39e589
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 0 deletions.
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 `[/#ISSUE_ID] Commit message`

Example:

```
[/#ISSUE_ID] My cool feature
```

## Pull Request

### Title

Pull Request title should follow below format:

```
[/#ISSUE_ID] ISSUE_TITLE
```

Example:

```
[/#ISSUE_ID] Whatever the name of ticket is
```

### Description

Description has to have `Resolves /#ISSUE_ID` with relevant issue. It will help automatically close relevant issue once the PR is merged.

Example:

```
Resolves /#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.
-->
9 changes: 9 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Resolves /#ISSUE_ID
<!--
Pull Request Checklist
1. I have read the https://github.com///blob/develop/docs/CONTRIBUTING.md
2. PR title in the format of `[/#ISSUE_ID] ISSUE_TITLE`
3. I have added a valid description and
4. I replaced `ISSUE_ID` with the ID(number in the link) of issue.
5. I have tested the app before creating this PR
-->

0 comments on commit f39e589

Please sign in to comment.