The following is a set of guidelines for contributing to the NGINX Ingress Operator. We really appreciate that you are considering contributing!
To ask a question please use Github Discussions.
You can also join our Community Slack which has a wider NGINX audience.
Please reserve GitHub issues for feature requests and bugs rather than general questions.
Follow our Installation Guide to get the NGINX Ingress Operator up and running.
Read the documentation .
- This Operator was created the using the Helm operator-framework and supports both the open source NGINX Ingress Controller and NGINX Plus Ingress Controller. It supports the same NGINX Ingress Controller features as the NGINX Ingress Controller Helm chart.
To report a bug, open an issue on GitHub with the label bug
using the available bug report issue template. Please ensure the issue has not already been reported.
To suggest an enhancement, please create an issue on GitHub with the label enhancement
using the available feature issue template.
- Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
- Fill in our pull request template
Note
If you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
- When an issue or PR is created, it will be triaged by the core development team and assigned a label to indicate the type of issue it is (bug, feature request, etc) and to determine the milestone. Please see the Issue Lifecycle document for more information.
- Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
- Follow the guidelines of writing a good commit message as described here https://chris.beams.io/posts/git-commit/ and summarized in the next few points
- In the subject line, use the present tense ("Add feature" not "Added feature")
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the subject line to 72 characters or less
- Reference issues and pull requests liberally after the subject line
- Add more detailed description in the body of the git message (
git commit -a
to give you more space and time in your text editor to write a good message instead ofgit commit -am
)