Skip to content

Commit 39bb48c

Browse files
Initial commit for GitHub Pages deployment
1 parent 3b252ce commit 39bb48c

File tree

3 files changed

+5
-11
lines changed

3 files changed

+5
-11
lines changed

branch_protection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
- All PRs must have a clear description explaining the changes.
2020
- Reference the Jira ticket ID in the PR title or description.
2121
- Follow the coding standards of the project.
22-
- PRs should be small and focused. Read more about writing effective PRs [here] ('./pr_guideline.md')
22+
- PRs should be small and focused. Read more about writing effective PRs [here](./pr_guideline.md)
2323
- PRs should have appropriate labels for tracking purposes.
2424

2525
### 2.2 Code Review Process

docs/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
```markdown
44
## Git Principles
5-
- [Branch Protection](/branch_standards.md)
6-
- [API Guidelines](/api-guidelines.md)
5+
- [Branch Protection](/branch_protection.md)
76
- [Review Process](/pr_guideline.md)
87

98
## Quick Links

pr_guideline.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ to use for work and add your name to that.
2525

2626
## <a name="leave-in-draft">Leave pull requests in draft until they are potentially ready to merge</a>
2727

28-
When first opening a pull request, use [GitHub’s ‘draft feature] to create it as a draft. This will prevent code owners
28+
When first opening a pull request, use [GitHub's 'draft' feature] to create it as a draft. This will prevent code owners
2929
from being tagged prematurely.
3030

3131
Only once you feel it is potentially production-ready, mark it as 'ready for review'. This will then automatically tag
3232
the code owners.
3333

3434
If you want to get an early review while a pull request is still in draft, that's fine.
3535

36-
[github’s ‘draft feature]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
36+
[github's 'draft' feature]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
3737

3838

3939
## <a name="dont-request-review-until-tests-passed">Don't request a review until tests have passed</a>
@@ -141,12 +141,7 @@ Complex PRs can take a lot of time to review: if you need a fast turnaround, the
141141

142142
## <a name="acknowledge-comments">Acknowledge every review comment</a>
143143

144-
Always respond to every comment to indicate to the reviewer that you’ve seen and thought about what they said. This
145-
doesn't have to be onerous: often a 👍 reaction is sufficient.
146-
147-
## <a name="acknowledge-comments">Acknowledge every review comment</a>
148-
149-
Always respond to every comment to indicate to the reviewer that you’ve seen and thought about what they said. This
144+
Always respond to every comment to indicate to the reviewer that you've seen and thought about what they said. This
150145
doesn't have to be onerous: often a 👍 reaction is sufficient.
151146

152147
## <a name="make-clear-what-has-changed-since-last-review">When re-requesting reviews, make it clear what has changed</a>

0 commit comments

Comments
 (0)