Skip to content

Commit d2aa6da

Browse files
Merge pull request #17 from zopdev/add-contribution-guidelines
added the contributing doc file
2 parents 98ba3e0 + a748490 commit d2aa6da

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to this project! We welcome contributions to both the frontend and backend APIs, which are maintained in the same repository.
4+
5+
## Code of Conduct
6+
7+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for everyone.
8+
9+
## How to Contribute
10+
11+
### Reporting Bugs
12+
13+
Did you find a bug? Encountered a hiccup in deployment? Discripency in documentation? We want to know! Raise an issue to let us know to get it fixed swiftly.
14+
15+
- Open an issue with a clear title and description.
16+
- Include steps to reproduce, expected behavior, actual behavior, and environment details.
17+
18+
### Suggesting Enhancements
19+
20+
If you spot a feature that isn't part of our official plan but could propel Zopdev forward, don't hesitate. Create an enhancement issue, and let us know you're ready to take the lead. We'll be quick to respond.
21+
22+
- Open an issue describing the enhancement you’d like to see.
23+
- Explain the motivation and potential use case.
24+
25+
#### Talk to us first
26+
27+
We encourage you to [discuss](https://github.com/zopdev/zopdev/discussions) your ideas before starting work on a large feature or change. This helps us ensure that your contribution aligns with the project goals and avoids duplication of effort.
28+
29+
### Submitting Pull Requests
30+
31+
1. Fork the repository and create a new branch.
32+
2. Make your changes, including tests and documentation if applicable.
33+
3. Ensure code passes linting and tests.
34+
4. Submit a pull request to the `main` branch with a descriptive title and summary.
35+
36+
<!-- ## Development Setup
37+
Follow respective setup instructions for frontend and backend.
38+
- **Frontend:** [Frontend Setup Instructions](https://github.com/zopdev/zopdev/frontend/README.md)
39+
- **Backend:** [Backend Setup Instructions](https://github.com/zopdev/zopdev/backend/README.md) -->
40+
41+
## Testing Policies
42+
43+
Testing is a crucial aspect of software development, and adherence to these guidelines ensures the stability, reliability, and maintainability of the zopdev codebase.
44+
45+
## Code Style
46+
47+
- **Frontend:** Follow the [JavaScript Standard Style Guide](https://github.com/standard/standard)
48+
49+
---
50+
51+
We appreciate your contributions and your effort to make this project better!

0 commit comments

Comments
 (0)