Skip to content

Commit ffccb08

Browse files
committed
📝 Add CODE_OF_CONDUCT.md, SECURITY.md, and CONTRIBUTING.md for improved community guidelines
1 parent 05d963e commit ffccb08

File tree

3 files changed

+113
-0
lines changed

3 files changed

+113
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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, caste, color, 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 for the **Secure Source Code Analyzer** project.
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+
- Providing 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 for the overall community and the project
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and unwelcome sexual attention or advances
22+
- Trolling, insulting, or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as physical or email addresses, without 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 do not align with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies to all community spaces, including GitHub repositories, issue trackers, discussion forums, and public channels where individuals represent this project or community. This also applies when an individual is officially representing the project in public spaces, such as when using an official email address, social media account, or acting as an appointed representative at an 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 **brianward.tech@outlook.com**. 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 to determine the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**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.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**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.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**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.
64+
65+
### 4. Permanent Ban
66+
67+
**Community 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.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74+
75+
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
76+
77+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to Secure Source Code Analyzer
2+
3+
Thank you for your interest in contributing! Please follow these guidelines to make the process smooth and enjoyable for everyone.
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository** and create a new branch for your changes.
8+
2. **Create a Pull Request**: After committing your changes, open a pull request with a clear description.
9+
3. **Write Clear Commit Messages**: Use an emoji and a brief, descriptive message (e.g., `📝 Add CONTRIBUTING.md`).
10+
11+
## Code of Conduct
12+
13+
All contributors are expected to adhere to the [Code of Conduct](./CODE_OF_CONDUCT.md). Please be respectful and constructive.
14+
15+
## Reporting Issues
16+
17+
If you find a bug or have a feature request, please [open an issue](https://github.com/bvvard/secure-source-code-analyzer/issues) with as much detail as possible.
18+
19+
## Code Guidelines
20+
21+
- Use clear and descriptive variable names.
22+
- Follow PEP8 guidelines for Python code.
23+
- Write unit tests for new features or bug fixes.

‎SECURITY.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security issue, please report it responsibly. Do not publicly disclose it until it has been addressed.
6+
7+
### How to Report
8+
9+
- Contact the maintainers by email at [contact@brianward.tech](mailto:brianwad.tech@outlook.com).
10+
- Describe the issue in detail, including steps to reproduce it if possible.
11+
- The maintainers will acknowledge receipt within 48 hours and work with you to address the issue.
12+
13+
Thank you for helping us make Secure Source Code Analyzer safer for everyone.

0 commit comments

Comments
 (0)