Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

74 lines (45 loc) · 3.99 KB

Contributing guidelines

The following are a set of guidelines for contributing to this project. We appreciate your desire to get involved!

If you are an F5 employee, see the following additional guidance on Maintainers etiquette.

Table of contents

Create an issue

One way to contribute to the project is by creating an issue.

The two most common are enhancements and bug reports. When using the issue templates, they will be automatically labelled.

  • An enhancement is an improvement of some kind, such as a new document or additional detail for a product feature
  • A bug report draws attention to an issue in documentation, such as an incorrect command or outdated information

Before creating an issue, please check there is no existing issue for the topic.

We encourage discussions within issues, since they act as a source of contextual truth and are linked to pull requests.

Start a discussion

We encourage you to use GitHub Discussions for conversations with the community and maintainers.

If you'd like to discuss something NGINX-related that doesn't involve documentation, you should go to the NGINX Community Forum.

Submit a pull request

Before making documentation changes, you should view the documentation style guide and Managing content with Hugo.

To understand how we use Git in this repository, read our Git conventions documentation.

The broad workflow is as follows:

  • Fork the NGINX repository
    • If you're an F5/NGINX user, you can branch directly with a clone
  • Create a branch
  • Implement your changes in your branch
  • Submit a pull request (PR) when your changes are ready for review

Alternatively, you're welcome to suggest improvements to highlight problems with our documentation as described in our support page.

Issue lifecycle

To ensure a balance between work carried out by the NGINX team while encouraging community involvement on this project, we use the following issue lifecycle:

  • A new issue is created by
  • A maintainer from the F5 team is assigned to the issue; this maintainer shepherds the issue through the subsequent stages in the issue lifecycle
  • The maintainer assigns one or more labels to the issue

Additional NGINX documentation

This repository does not include all of the source content for the NGINX documentation. Other relevant repositories include:

In those repositories, you can find documentation source code in the docs or site subdirectories.

F5 Contributor License Agreement

F5 requires all external contributors to agree to the terms of the F5 CLA (available here) before any of their changes can be incorporated into an F5 Open Source repository.

If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.