[#88] Update docs to trick file-sync bug (#89)

Oztechan · Jan 17, 2024 · a3db254 · a3db254
1 parent 8eb2e70
commit a3db254
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 ## 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.
+Branch name should start with `ISSUE_ID` and after the id there should be `-` and then it continues with description of branch or title of ticket. Use `_` for empty spaces.
 
 Example:
 
@@ -38,7 +38,7 @@ Example:
 
 ### Description
 
-Description has to have `Resolves {{ repository.owner }}/{{ repository.name }}#ISSUE_ID` with relevant issue. It will help automatically close relevant issue once the PR is merged.
+Description has to have `Resolves {{ repository.owner }}/{{ repository.name }}#ISSUE_ID` with relevant issue. It will help project automations.
 
 Example:
 

diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md
@@ -2,8 +2,8 @@ Resolves {{ repository.owner }}/{{ repository.name }}#ISSUE_ID
 <!--
 Pull Request Checklist
 1. I have read the https://github.com/{{ repository.owner }}/{{ repository.name }}/blob/develop/docs/CONTRIBUTING.md
-2. PR title in the format of `[{{ repository.owner }}/{{ repository.name }}#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.
+2. PR title is in the format of `[{{ repository.owner }}/{{ repository.name }}#ISSUE_ID] ISSUE_TITLE`
+3. I have added a valid description and pictures if necessary.
+4. I replaced `ISSUE_ID` with the ID of issue.
 5. I have tested the app before creating this PR 
 -->