Skip to content

Commit 8ae551f

Browse files
committed
Add/improve docs for Community Standards
suggested by Github and Copilot
1 parent 33e3afd commit 8ae551f

File tree

4 files changed

+186
-13
lines changed

4 files changed

+186
-13
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
1+
---
2+
name: General Issue
3+
about: Report a bug or request a feature. For support, please use Stack Exchange.
4+
---
5+
16
Please only open issues for bug reports or feature requests.
27
The developers do not have the resources to provide individual support.
38
For support, please turn to the most applicable Stack Exchange site, such as
49
[Information Security](https://security.stackexchange.com/),
510
[Network Engineering](https://networkengineering.stackexchange.com/) or
611
[Super User](https://superuser.com/).
712

8-
For bug reports, please supply:
13+
---
14+
15+
### For bug reports, please supply:
916

10-
- Output of `sslproxy -V`
11-
- Output of `uname -a`
12-
- Exact command line arguments used to run `sslproxy`
13-
- Relevant part of debug mode (-D) output, if applicable
14-
- NAT redirection rules you are using, if applicable
15-
- List of failing unit tests in `make test` output
16-
- Other relevant data such as PCAPs, logs, screenshots etc
17+
- Output of `sslproxy -V`
18+
- Output of `uname -a`
19+
- Exact command line arguments used to run `sslproxy`
20+
- Relevant part of debug mode (-D) output, if applicable
21+
- NAT redirection rules you are using, if applicable
22+
- List of failing unit tests in `make test` output
23+
- Other relevant data such as PCAPs, logs, screenshots etc
1724

18-
For build problems, please supply:
25+
---
1926

20-
- Output of `uname -a`
21-
- Full output of failed `make` including the header
22-
- Version and origin of OpenSSL used
23-
- Version and origin of libevent used
27+
### For build problems, please supply:
2428

29+
- Output of `uname -a`
30+
- Full output of failed `make` including the header
31+
- Version and origin of OpenSSL used
32+
- Version and origin of libevent used

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Pull Request
2+
3+
Thank you for your contribution!
4+
5+
Please use this template to help us review your changes efficiently.
6+
7+
---
8+
9+
## Description
10+
11+
- What does this PR do?
12+
- What problem does it solve or what feature does it add?
13+
- Is this related to an open issue? If so, reference it here.
14+
15+
## Checklist
16+
17+
- [ ] I have read and agreed to the [Code of Conduct](../CODE_OF_CONDUCT.md).
18+
- [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md).
19+
- [ ] My code builds and passes all tests (`make test` or equivalent).
20+
- [ ] I have added or updated documentation as needed.
21+
- [ ] I have tested the changes and verified new and existing functionality works as expected.
22+
23+
## Additional Information
24+
25+
- Any special instructions for testing?
26+
- Screenshots, logs, or other supporting materials, if applicable.
27+
28+
---
29+
30+
*Thank you for helping to improve this project!*

CODE_OF_CONDUCT.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
**Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
49+
**Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
50+
51+
### 2. Warning
52+
**Impact:** A violation through a single incident or series of actions.
53+
**Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
54+
55+
### 3. Temporary Ban
56+
**Impact:** A serious violation of community standards, including sustained inappropriate behavior.
57+
**Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
58+
59+
### 4. Permanent Ban
60+
**Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
61+
**Consequence:** A permanent ban from any sort of public interaction within the community.
62+
63+
## Attribution
64+
65+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
66+
67+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
68+
69+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing to This Project
2+
3+
Thank you for your interest in contributing! Your work helps improve and sustain this open source project.
4+
5+
---
6+
7+
## 🐞 Bug Reports & Feature Requests
8+
9+
- **Please use GitHub Issues only for bug reports and feature requests.**
10+
- We do **not** provide individual support through GitHub issues.
11+
- For user support or troubleshooting, please use:
12+
- [Information Security Stack Exchange](https://security.stackexchange.com/)
13+
- [Network Engineering Stack Exchange](https://networkengineering.stackexchange.com/)
14+
- [Super User](https://superuser.com/)
15+
16+
### When Reporting a Bug
17+
18+
Please include the following information where applicable:
19+
20+
- Output of `sslproxy -V`
21+
- Output of `uname -a`
22+
- Exact command line arguments used to run the software
23+
- Relevant debug output (`-D`)
24+
- NAT redirection rules in use, if relevant
25+
- List of failing unit tests from `make test`
26+
- Logs, PCAPs, screenshots, or other supporting materials
27+
28+
### When Reporting Build Problems
29+
30+
- Your OS version and output of `uname -a`
31+
- Full output of the failed `make` run (including the header)
32+
- Version and origin of OpenSSL and libevent
33+
34+
---
35+
36+
## 💡 Pull Requests
37+
38+
We welcome pull requests that:
39+
40+
- Fix bugs or security issues
41+
- Add features or usability improvements
42+
- Improve documentation or tests
43+
44+
### Guidelines
45+
46+
- Fork the repository and create your branch from `main` or the default branch.
47+
- Write clear, descriptive commit messages.
48+
- Ensure your code passes existing tests (`make test` or equivalent).
49+
- Add new tests for new features or bug fixes if possible.
50+
- Document any new behavior or configuration options.
51+
- Make sure your code style is consistent with the rest of the project.
52+
53+
---
54+
55+
## 📝 Code of Conduct
56+
57+
This project is governed by a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
58+
59+
---
60+
61+
## 🙏 Thank You
62+
63+
We appreciate your time and interest in making this project better!
64+
Your contributions help keep open source security strong.
65+
66+
---

0 commit comments

Comments
 (0)