Skip to content

Update CONTRIBUTING.md #154

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 2 commits into from
Feb 3, 2025
Merged

Update CONTRIBUTING.md #154

merged 2 commits into from
Feb 3, 2025

Conversation

jputrino
Copy link
Contributor

@jputrino jputrino commented Jan 30, 2025

Proposed changes

Clarifies the section of the contribution guide that covers docs not developed in this repo:

  • adds nginx/nginx.org repo
  • adds nginx/nginx-agent repo
  • removes nginx/nginx-gateway-fabric repo because the NGF docs now reside here
  • adds information to each repo in the list that indicates what it is the source for

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • 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 and 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

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

Clarifies the section of the contribution guide that covers docs not developed in this repo:
- adds `nginx/nginx.org` repo
- adds `nginx/nginx-agent` repo
- removes `nginx/nginx-gateway-fabric` repo
@jputrino jputrino requested a review from a team as a code owner January 30, 2025 21:57
Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense.

@jputrino jputrino enabled auto-merge (rebase) January 30, 2025 22:36
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/154/

@jputrino jputrino merged commit 1bbe08a into main Feb 3, 2025
4 checks passed
@jputrino jputrino deleted the jputrino-patch-1-1 branch February 3, 2025 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants