Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.

Commit 62e351a

Browse files
dwmcallisterac000
authored andcommitted
Update CONTRIBUTING.md for archiving
Signed-off-by: Andrew Clayton <[email protected]>
1 parent f41bea3 commit 62e351a

File tree

1 file changed

+2
-93
lines changed

1 file changed

+2
-93
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,3 @@
1-
# Contributing Guidelines
2-
3-
The following is a set of guidelines for contributing to NGINX Unit. We do
4-
appreciate that you are considering contributing!
5-
6-
## Table Of Contents
7-
8-
- [Getting Started](#getting-started)
9-
- [Ask a Question](#ask-a-question)
10-
- [Contributing](#contributing)
11-
- [Git Style Guide](#git-style-guide)
12-
13-
14-
## Getting Started
15-
16-
Check out the [Quick Installation](README.md#quick-installation) and
17-
[Howto](https://unit.nginx.org/howto/) guides to get NGINX Unit up and
18-
running.
19-
20-
21-
## Ask a Question
22-
23-
Please open an [issue](https://github.com/nginx/unit/issues/new) on GitHub
24-
with the label `question`. You can also ask a question on
25-
[GitHub Discussions](https://github.com/nginx/unit/discussions) or the NGINX
26-
Unit mailing list, [email protected] (subscribe
27-
[here](https://mailman.nginx.org/mailman3/lists/unit.nginx.org/)).
28-
29-
30-
## Contributing
31-
32-
### Report a Bug
33-
34-
Ensure the bug was not already reported by searching on GitHub under
35-
[Issues](https://github.com/nginx/unit/issues).
36-
37-
If the bug is a potential security vulnerability, please report using our
38-
[security policy](https://unit.nginx.org/troubleshooting/#getting-support).
39-
40-
To report a non-security bug, open an
41-
[issue](https://github.com/nginx/unit/issues/new) on GitHub with the label
42-
`bug`. Be sure to include a title and clear description, as much relevant
43-
information as possible, and a code sample or an executable test case showing
44-
the expected behavior that doesn't occur.
45-
46-
47-
### Suggest an Enhancement
48-
49-
To suggest an enhancement, open an
50-
[issue](https://github.com/nginx/unit/issues/new) on GitHub with the label
51-
`enhancement`. Please do this before implementing a new feature to discuss
52-
the feature first.
53-
54-
55-
### Open a Pull Request
56-
57-
Before submitting a PR, please read the NGINX Unit code guidelines to know
58-
more about coding conventions and benchmarks. Fork the repo, create a branch,
59-
and submit a PR when your changes are tested and ready for review. Again, if
60-
you'd like to implement a new feature, please consider creating a feature
61-
request issue first to start a discussion about the feature.
62-
63-
64-
## Git Style Guide
65-
66-
- Create atomic commits. A commit should do just one thing, i.e. you
67-
shouldn't mix refactoring with functional code changes. Do the
68-
refactoring in one or more commits first.
69-
70-
Ideally you should rebase locally and force push new commits up.
71-
72-
- In the subject line, use the imperative mood. I.e. write the subject like
73-
you're giving git a command, e.g. "Free memory before exiting". Do not
74-
terminate the subject with a `.`
75-
76-
- Try to limit the subject line to around 50 characters, but try not to
77-
exceed 72.
78-
79-
- Wrap the body of the commit message after 72 characters.
80-
81-
- Use lowercase subject line prefixes for commits that affect a specific
82-
portion of the code; examples include "tests:", "ci:", or "http:", and
83-
also individual languages such as "python:" or "php:". If multiple areas
84-
are affected you can specify multiple prefixes, e.g. "auto, perl:"
85-
86-
- If the commit fixes an open issue then you can use the "Closes:"
87-
tag/trailer to reference it and have GitHub automatically close it once
88-
it's been merged. E.g.:
89-
90-
`Closes: https://github.com/nginx/unit/issues/9999`
91-
92-
That should go at the end of the commit message, separated by a blank line,
93-
along with any other tags.
1+
## Note: This repository has been archived. There will likely be no further development at this repo, and security vulnerabilities may be unaddressed. No contributions are accepted; however, the repo may be forked and used in alignment with the license.
942

3+
If you have questions on this project as archived, please ask them on the [NGINX Community Forum](https://community.nginx.org).

0 commit comments

Comments
 (0)