Skip to content

Commit 4a50582

Browse files
committed
Updates to README-type files
- Sync Code of Conduct info to template-repository - Update pull request template for spacing issue - Include notes on private/public repo info to F5-NGINX-team-notes file
1 parent 5690c59 commit 4a50582

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Closes #ISSUE
1919

2020
Before creating a PR, run through this checklist and mark each as complete.
2121

22-
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md).
23-
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md).
24-
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works.
25-
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes.
26-
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)).
22+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
23+
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
24+
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
25+
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
26+
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md))
2727
- [ ] I have rebased my branch onto main
2828
- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
2929
- [ ] If the change involves:
@@ -33,4 +33,4 @@ Before creating a PR, run through this checklist and mark each as complete.
3333
- URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0))
3434
- Significant new/revised content
3535

36-
In these cases, the change will require at least two (2) approvals before merging.
36+
In these cases, the change will require at least two (2) approvals before merging

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,5 @@ This Code of Conduct is adapted from the [Contributor Covenant](https://www.cont
7474

7575
Community Impact Guidelines were inspired by
7676
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
77+
78+
For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

F5-NGINX-team-notes.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ public repository. However, if you are working with:
66
- Security content, including personally identifying information (PII).
77
- Content / features that are not yet ready to be announced.
88

9-
Make changes to the `docs-internal` repository. When you create a branch, start it with:
9+
Make changes to the private `docs` repository. When you create a branch, start it with:
1010
`internal/`.
1111

12-
- The public `docs` repository will reject branches that start with `internal/`.
13-
- The `docs-internal` repository will accept branches _only_ if it includes `internal/`.
12+
- The public `documentation` repository will reject branches that start with `internal/`.
13+
- The private `docs` repository will accept branches _only_ if it includes `internal/`.
14+
15+
Before new content is published, it must be written to the open `documentation` repository. After you get approvals in the internal `docs` repository, you'll need to create a _second_ pull request in the open `documentation` repository.
1416

1517
If you need to review a pull request and are an employee of F5/NGINX, ask a member of @nginx/nginx-docs for help.
1618

0 commit comments

Comments
 (0)