Skip to content

Commit fae1b11

Browse files
Merge pull request #89 from walters-labs/migrate-towards-REST-style-API
create `CONTRIBUTING.md`
2 parents e816880 + 94683f9 commit fae1b11

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to Open Encrypt
2+
3+
Thank you for your interest in contributing to Open Encrypt! We welcome contributions from everyone. To help us keep the project organized and maintain a high standard, please follow these guidelines.
4+
5+
## How to Contribute
6+
7+
### Fork the repository
8+
9+
1. Fork the Open Encrypt repository to your own GitHub account.
10+
2. Clone your fork locally:
11+
12+
```
13+
git clone https://github.com/your-username/open-encrypt.git
14+
cd open-encrypt
15+
```
16+
17+
3. Create a new branch for your feature or bugfix:
18+
19+
```
20+
git checkout -b my-feature-branch
21+
```
22+
23+
### Make your changes
24+
25+
- Write clear, concise commit messages.
26+
- Ensure your code follows the project's coding style.
27+
- Add tests for new features or bug fixes.
28+
- Update documentation if necessary.
29+
30+
### Submit your changes
31+
32+
1. Push your branch to your fork:
33+
34+
```
35+
git push origin my-feature-branch
36+
```
37+
38+
2. Open a pull request on the main Open Encrypt repository.
39+
3. Fill out the PR template with a clear description of your changes.
40+
4. Respond to any feedback or requested changes from maintainers.
41+
42+
## Code of Conduct
43+
44+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and considerate.
45+
46+
## Reporting Issues
47+
48+
If you find a bug or want to request a new feature, please open an issue in the repository. Provide as much detail as possible to help us understand the problem.
49+
50+
---
51+
52+
Thanks again for helping improve Open Encrypt!

0 commit comments

Comments
 (0)