Skip to content

Commit 1556992

Browse files
committed
Added community related docs.
1 parent 6f20307 commit 1556992

File tree

5 files changed

+200
-0
lines changed

5 files changed

+200
-0
lines changed

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the moderation team at <[email protected]>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
72+
73+
For answers to common questions about this code of conduct, see
74+
<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing Guidelines
2+
3+
The following is a set of guidelines for contributing to NGINX Open Source
4+
packaging. We really appreciate that you are considering contributing!
5+
6+
#### Table Of Contents
7+
8+
[Getting Started](#getting-started)
9+
10+
[Contributing](#contributing)
11+
12+
[Code Guidelines](#code-guidelines)
13+
14+
[Code of Conduct](https://github.com/nginx/pkg-oss/blob/master/CODE_OF_CONDUCT.md)
15+
16+
## Getting Started
17+
18+
The `master` branch holds packaging sources for the current mainline version,
19+
while `stable-*` branches contain latest sources for stable releases.
20+
21+
To build binary packages, run `make` in `debian/` directory on Debian/Ubuntu, or in
22+
`rpm/SPECS/` on RHEL and derivatives, SLES, and Amazon Linux, or in `alpine/` on Alpine.
23+
24+
## Contributing
25+
26+
### Report a Bug
27+
28+
To report a bug, open an issue on GitHub with the label `bug`. Please ensure the bug has not already been
29+
reported. **If the bug is a potential security vulnerability, please report it
30+
using our [security policy](https://github.com/nginx/pkg-oss/blob/master/SECURITY.md).**
31+
32+
### Suggest a Feature or Enhancement
33+
34+
To suggest a feature or enhancement, please create an issue on GitHub with the
35+
label `enhancement`. Please ensure the feature or enhancement has not already
36+
been suggested.
37+
38+
### Open a Pull Request
39+
40+
- Fork the repo, create a branch, implement your changes, add any relevant
41+
tests, submit a PR when your changes are **tested** and ready for review.
42+
43+
Note: if you'd like to implement a new feature, please consider creating a
44+
feature request issue first to start a discussion about the feature.
45+
46+
## Code Guidelines
47+
48+
### Git Guidelines
49+
50+
- Keep a clean, concise and meaningful git commit history on your branch
51+
(within reason), rebasing locally and squashing before submitting a PR.
52+
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
53+
format when writing a commit message, so that changelogs can be automatically generated.
54+
55+
- Follow the guidelines of writing a good commit message as described here
56+
<https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
57+
- In the subject line, use the present tense ("Add feature" not "Added feature").
58+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
59+
- Limit the subject line to 72 characters or less.
60+
- Reference issues and pull requests liberally after the subject line.
61+
- Add more detailed description in the body of the git message (`git commit -a`
62+
to give you more space and time in your text editor to write a good message instead of `git commit -am`).
63+

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2+
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginx/pkg-oss/blob/master/SUPPORT.md)
3+
4+
# About this Repo
5+
6+
## Maintained by: [the NGINX packaging maintainers](https://github.com/nginx/pkg-oss)
7+
8+
This is the Git repo of the [official packages](https://nginx.org/en/linux_packages.html) for [`NGINX Open Source`](https://nginx.org/). It is used as a source of truth to build binary packages for all supported Linux distributions and their variants.
9+
10+
The changelog for NGINX releases is available at [nginx.org changes page](https://nginx.org/en/CHANGES).
11+
12+
## Contributing
13+
14+
Please see the [contributing guide](https://github.com/nginx/pkg-oss/blob/master/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
15+
16+
## License
17+
18+
[BSD 2-Clause](https://github.com/nginx/pkg-oss/blob/master/LICENSE)
19+
20+
&copy; [F5, Inc.](https://www.f5.com/) 2025

SECURITY.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Security Policy
2+
3+
## Latest Versions
4+
5+
We advise users to run or update to the most recent release of NGINX Open Source packages. Older versions of NGINX packages may not have all enhancements and/or bug fixes applied to them.
6+
7+
## Reporting a Vulnerability
8+
9+
The F5 Security Incident Response Team (F5 SIRT) has an email alias that makes it easy to report potential security vulnerabilities.
10+
11+
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
12+
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at <[email protected]>.
13+
14+
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)

SUPPORT.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Support
2+
3+
## Ask a Question
4+
5+
We use GitHub for tracking bugs and feature requests related to all NGINX Open Source packaging.
6+
7+
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`.
8+
9+
## NGINX Specific Questions and/or Issues
10+
11+
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
12+
13+
### Documentation
14+
15+
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
16+
17+
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
18+
19+
### GitHub Discussions
20+
21+
Want to get in touch with the NGINX development team directly? Try opening a discussion on <https://github.com/nginx/nginx/discussions>!
22+
23+
## Contributing
24+
25+
Please see the [contributing guide](https://github.com/nginx/pkg-oss/blob/master/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
26+
27+
## Commercial Support
28+
29+
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.f5.com/products/get-f5) or check your contract details for more info!

0 commit comments

Comments
 (0)