summaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAndrew Clayton <a.clayton@nginx.com>2024-07-09 02:11:55 +0100
committerAndrew Clayton <a.clayton@nginx.com>2024-08-07 02:16:15 +0100
commit0f313e2b4d6737f15bd69e3d9c7761360bd43f76 (patch)
treed9b15dfe9b3629689f6cb6bb86f2f24096324cb4 /CONTRIBUTING.md
parent06c4ea1ff1c4d0fe5bb8881656b03097767017ac (diff)
downloadunit-0f313e2b4d6737f15bd69e3d9c7761360bd43f76.tar.gz
unit-0f313e2b4d6737f15bd69e3d9c7761360bd43f76.tar.bz2
CONTRIBUTING.md: Re-flow text
Re-flow text to wrap a little before the 80 column mark, this improves the reading/editing experience in standard ANSI terminals and also improves the diffing by reducing the amount of wrapping that then occurs with the +/- additions. This is a preparatory patch for future editing of this document. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md37
1 files changed, 19 insertions, 18 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 77343271..2d8bd230 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,15 +14,16 @@ appreciate that you are considering contributing!
## Getting Started
Check out the [Quick Installation](README.md#quick-installation) and
-[Howto](https://unit.nginx.org/howto/) guides to get NGINX Unit up and running.
+[Howto](https://unit.nginx.org/howto/) guides to get NGINX Unit up and
+running.
## Ask a Question
-Please open an [issue](https://github.com/nginx/unit/issues/new) on GitHub with
-the label `question`. You can also ask a question on
-[GitHub Discussions](https://github.com/nginx/unit/discussions) or the NGINX Unit mailing list,
-unit@nginx.org (subscribe
+Please open an [issue](https://github.com/nginx/unit/issues/new) on GitHub
+with the label `question`. You can also ask a question on
+[GitHub Discussions](https://github.com/nginx/unit/discussions) or the NGINX
+Unit mailing list, unit@nginx.org (subscribe
[here](https://mailman.nginx.org/mailman3/lists/unit.nginx.org/)).
@@ -47,17 +48,17 @@ the expected behavior that doesn't occur.
To suggest an enhancement, open an
[issue](https://github.com/nginx/unit/issues/new) on GitHub with the label
-`enhancement`. Please do this before implementing a new feature to discuss the
-feature first.
+`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.
+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
@@ -66,13 +67,13 @@ issue first to start a discussion about the feature.
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.
+ `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
+- 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