Skip to content

Commit e4d5d24

Browse files
committed
Add CONTRIBUTING.md and CODE_OF_CONDUCT.md
1 parent 73ccda8 commit e4d5d24

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our project and 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:
12+
- Using welcoming and inclusive language
13+
- Being respectful of differing viewpoints and experiences
14+
- Gracefully accepting constructive criticism
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior:
18+
- The use of sexualized language or imagery
19+
- Trolling, insulting or derogatory comments, and personal or political attacks
20+
- Public or private harassment
21+
- Publishing others' private information without explicit permission
22+
23+
## Enforcement Responsibilities
24+
25+
Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
26+
27+
## Scope
28+
29+
This Code of Conduct applies within all project spaces and in public spaces when an individual is representing the project or its community.
30+
31+
## Enforcement
32+
33+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting Cody Marsengill at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
34+
35+
## Attribution
36+
37+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to CodeSleuth
2+
3+
Thank you for your interest in contributing to CodeSleuth! We welcome bug reports, feature requests, and pull requests.
4+
5+
## How to Contribute
6+
7+
- **Report Issues:**
8+
- Use [GitHub Issues](https://github.com/Cod-e-Codes/codesleuth/issues) to report bugs or request features.
9+
- Please provide as much detail as possible, including steps to reproduce bugs.
10+
11+
- **Submit Pull Requests:**
12+
- Fork the repository and create your branch from `main`.
13+
- Write clear, concise commit messages (see below).
14+
- Ensure your code passes all tests and lints.
15+
- Open a pull request with a clear description of your changes.
16+
17+
## Coding Style
18+
19+
- Follow idiomatic style for each language:
20+
- **Rust:** [Rust Style Guide](https://doc.rust-lang.org/1.0.0/style/)
21+
- **Go:** [Effective Go](https://golang.org/doc/effective_go.html)
22+
- **Python:** [PEP 8](https://www.python.org/dev/peps/pep-0008/)
23+
- Use descriptive variable and function names.
24+
- Write docstrings/comments for complex logic.
25+
26+
## Commit Messages
27+
28+
- Use the present tense ("Add feature" not "Added feature").
29+
- Start with a short summary, followed by a blank line and more detail if needed.
30+
- Reference issues or PRs when relevant (e.g., `Fixes #12`).
31+
32+
## Contact
33+
34+
For questions, open an issue or contact Cody Marsengill at [email protected].
35+
36+
---
37+
38+
Happy coding!

0 commit comments

Comments
 (0)