diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5d0b4c843..7f3e9732c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -19,11 +19,11 @@ Closes #ISSUE Before creating a PR, run through this checklist and mark each as complete. -- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md). -- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md). -- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works. -- [ ] If applicable, I have checked that any relevant tests pass after adding my changes. -- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)). +- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md) +- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) +- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works +- [ ] If applicable, I have checked that any relevant tests pass after adding my changes +- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)) - [ ] I have rebased my branch onto main - [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork - [ ] If the change involves: @@ -33,4 +33,4 @@ Before creating a PR, run through this checklist and mark each as complete. - URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0)) - Significant new/revised content - In these cases, the change will require at least two (2) approvals before merging. + In these cases, the change will require at least two (2) approvals before merging diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7f68c0bc1..e18d3706b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -74,3 +74,5 @@ This Code of Conduct is adapted from the [Contributor Covenant](https://www.cont Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion). + +For answers to common questions about this code of conduct, see the FAQ at . Translations are available at . diff --git a/F5-NGINX-team-notes.md b/F5-NGINX-team-notes.md index 8aa597490..e1fbe2bb0 100644 --- a/F5-NGINX-team-notes.md +++ b/F5-NGINX-team-notes.md @@ -6,11 +6,13 @@ public repository. However, if you are working with: - Security content, including personally identifying information (PII). - Content / features that are not yet ready to be announced. -Make changes to the `docs-internal` repository. When you create a branch, start it with: +Make changes to the private `docs` repository. When you create a branch, start it with: `internal/`. -- The public `docs` repository will reject branches that start with `internal/`. -- The `docs-internal` repository will accept branches _only_ if it includes `internal/`. +- The public `documentation` repository will reject branches that start with `internal/`. +- The private `docs` repository will accept branches _only_ if it includes `internal/`. + +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. If you need to review a pull request and are an employee of F5/NGINX, ask a member of @nginx/nginx-docs for help.