Skip to content

Commit 348975d

Browse files
committed
Created contributing guidelines.
1 parent 72d0bb0 commit 348975d

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to CodeSafe
2+
3+
Thank you for considering contributing to **CodeSafe**! Contributions, whether they are bug fixes, new features, or improvements to the documentation, are always welcome. Before contributing, please read the following guidelines to ensure smooth collaboration.
4+
5+
## Getting Started
6+
7+
1. **Fork the Repository**
8+
Create a fork of this repository to your GitHub account and clone it locally.
9+
10+
2. **Set Up the Environment**
11+
Ensure you have Python 3.6+ installed. You should also install compatible versions of the necessary dependencies for the project.
12+
13+
3. **Run Tests**
14+
Before making changes, run tests to confirm that everything works.
15+
16+
> [!TIP]
17+
> We sometimes include testing scripts in our projects for easy testing.
18+
19+
## How to Contribute
20+
21+
1. **Report Issues**
22+
Use the [GitHub Issues page](https://github.com/Infinitode/CodeSafe/issues) to report bugs or suggest features. Please include:
23+
- A clear description of the issue or suggestion.
24+
- Steps to reproduce (for bugs).
25+
26+
2. **Make Changes**
27+
- Use clear and descriptive commit messages.
28+
- (Optional) Write tests to show new functionality.
29+
- Ensure the code is **readable**. You can learn more about Python code readability here: https://peps.python.org/pep-0008/.
30+
31+
3. **Submit a Pull Request**
32+
- Push your changes to a feature branch in your fork.
33+
- Submit a pull request with a detailed explanation of what you've changed or added.
34+
- Ensure your PR passes all automated tests and adheres to the contribution guidelines.
35+
36+
## Community Guidelines
37+
38+
To maintain a positive and collaborative community, we ask that all contributors adhere to the following principles:
39+
40+
1. **Be Respectful**
41+
Treat others with respect, regardless of their background or expertise.
42+
43+
2. **Provide Constructive Feedback**
44+
Offer helpful and actionable suggestions during code reviews.
45+
46+
3. **Follow Licensing Requirements**
47+
Ensure that any derivative works comply with the [license](https://github.com/infinitode/codesafe/blob/main/LICENSE).
48+
49+
By contributing, you agree to abide by these guidelines and this project's [license](https://github.com/infinitode/codesafe/blob/main/LICENSE). Thank you for helping make **CodeSafe** better!

0 commit comments

Comments
 (0)