Skip to content

Updates to README-type files #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
2 changes: 2 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
8 changes: 5 additions & 3 deletions F5-NGINX-team-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading