Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

90 lines (59 loc) · 3.22 KB
Raw

Contributing Guidelines

The following is a set of guidelines for contributing to NGINX Unit. We do appreciate that you are considering contributing!

Table Of Contents

Getting Started

Check out the Quick Installation and Howto guides to get NGINX Unit up and running.

Ask a Question

Please open an issue on GitHub with the label question. You can also ask a question on GitHub Discussions or the NGINX Unit mailing list, [email protected] (subscribe here).

Contributing

Report a Bug

Ensure the bug was not already reported by searching on GitHub under Issues.

If the bug is a potential security vulnerability, please report using our security policy.

To report a non-security bug, open an issue on GitHub with the label bug. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case showing the expected behavior that doesn't occur.

Suggest an Enhancement

To suggest an enhancement, open an issue on GitHub with the label enhancement. Please do this before implementing a new feature to discuss the feature first.

Open a Pull Request

Before submitting a PR, please read the NGINX Unit code guidelines to know more about coding conventions and benchmarks. Fork the repo, create a branch, and submit a PR when your changes are tested and ready for review. Again, if you'd like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.

Git Style Guide

  • Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR

  • For any user-visible changes, updates, and bugfixes, add a note to docs/changes.xml under the section for the upcoming release, using <change type="feature"> for new functionality, <change type="change"> for changed behavior, and <change type="bugfix"> for bug fixes.

  • In the subject line, use the past tense ("Added feature", not "Add feature"); also, use past tense to describe past scenarios, and present tense for current behavior

  • Limit the subject line to 67 characters, and the rest of the commit message to 80 characters

  • Use subject line prefixes for commits that affect a specific portion of the code; examples include "Tests:", "Packages:", or "Docker:", and also individual languages such as "Java:" or "Ruby:"

  • Reference issues and PRs liberally after the subject line; if the commit remedies a GitHub issue, name it accordingly

  • Don't rely on command-line commit messages with -m; use the editor instead