Skip to content

Commit f40e695

Browse files
nimisha-gjnimisha-gj
committed
chore: add community guidelines and security policy
- Added CODE_OF_CONDUCT.md to establish community behavior expectations - Added CONTRIBUTING.md to guide contributors on how to contribute effectively - Added SECURITY.md to outline security policies and reporting procedures
1 parent cb16494 commit f40e695

File tree

3 files changed

+238
-0
lines changed

3 files changed

+238
-0
lines changed

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
4+
5+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
6+
7+
## How to Contribute
8+
9+
### 1. Fork the Repository
10+
11+
[fork](https://help.github.com/articles/fork-a-repo/) the repository on GitHub and clone it to your local machine.
12+
13+
```bash
14+
git clone https://github.com/infraspecdev/mikrotik-wireguard-client-manager.git
15+
```
16+
17+
### 2. Create a Branch
18+
19+
Create a new branch for your feature or bug fix. Use a descriptive name for your branch.
20+
21+
```bash
22+
git checkout -b feature/your-feature-name
23+
```
24+
25+
### 3. Make Your Changes
26+
27+
Make the necessary changes to the codebase. Ensure your changes adhere to the project's coding standards.
28+
29+
### 4. Test Your Changes
30+
31+
Test your changes thoroughly to ensure they work as expected.
32+
33+
### 5. Commit Your Changes
34+
35+
Commit your changes with a descriptive commit message.
36+
Make sure to Sign your commits
37+
38+
```bash
39+
git add .
40+
git commit -m "Add feature: Description of your feature"
41+
```
42+
43+
### 6. Push Your Changes
44+
45+
Push your changes to your forked repository.
46+
47+
```bash
48+
git push origin feature/your-feature-name
49+
```
50+
51+
### 7. Create a Pull Request
52+
53+
Github has documentation on [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
54+
55+
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
56+
57+
- `feat:` for new features
58+
- `fix:` for bug fixes
59+
- `improvement:` for enhancements
60+
- `docs:` for documentation and examples
61+
- `refactor:` for code refactoring
62+
- `test:` for tests
63+
- `ci:` for CI purpose
64+
- `chore:` for chores stuff
65+
66+
The `chore` prefix skipped during changelog generation. It can be used for `chore: update changelog` commit message by example.
67+
68+
## Code Style
69+
70+
Please ensure your code follows the existing coding style and conventions.
71+
72+
## Reporting Issues
73+
74+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
75+
76+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
77+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
78+
79+
- The version of our code being used
80+
- Any modifications you've made relevant to the bug
81+
- Anything unusual about your environment or deployment
82+
83+
## Thank You
84+
85+
Thank you for contributing to `mikrotik-wireguard-client-manager` ! Your support is greatly appreciated.

‎SECURITY.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Security
2+
3+
Infraspec takes the security of our software products and services seriously, including all open-source code repositories managed through our organization, [Infraspec](https://github.com/infraspecdev/).
4+
5+
If you find any security vulnerabilities in our open source projects, please report them. We will ensure that your findings are passed along to the appropriate maintainers for remediation.
6+
7+
## Reporting Security Issues
8+
9+
If you believe you have found a security vulnerability in any Infraspec-owned repository, please report it to us through coordinated disclosure.
10+
11+
**Please do not report security vulnerabilities through public issues, discussions, or pull requests in Infraspec repositories.**
12+
13+
Instead, please send an email to <security@infrapsec.dev>.
14+
15+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
16+
17+
* The type of issue (e.g., improper input handling, token exposure or API abuse in the spell and grammar checking process)
18+
* Full paths of source file(s) related to the manifestation of the issue
19+
* The location of the affected source code (tag/branch/commit or direct URL)
20+
* Any special configuration required to reproduce the issue
21+
* Step-by-step instructions to reproduce the issue
22+
* Proof-of-concept or exploit code (if possible)
23+
* Impact of the issue, including how an attacker might exploit the issue
24+
25+
This information will help us triage your report more quickly.

0 commit comments

Comments
 (0)