Skip to content

Commit b493da8

Browse files
authored
Create CONTRIBUTING.md
1 parent d479dc7 commit b493da8

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# CONTRIBUTING.md
2+
3+
# Contributing to Cooketh Flow
4+
5+
Thank you for your interest in contributing to **Cooketh Flow**! 🚀 We welcome contributions of all kinds, including code, documentation, bug reports, and feature suggestions.
6+
7+
## How to Contribute
8+
9+
1. **Fork the Repository**: Click the `Fork` button at the top of the repository page to create your own copy.
10+
2. **Clone Your Fork**: Clone the repository to your local machine:
11+
```sh
12+
git clone https://github.com/your-username/Cooketh-Flow.git
13+
cd Cooketh-Flow
14+
```
15+
3. **Create a Branch**: Create a new branch for your changes from the `rewrite` branch:
16+
```sh
17+
git checkout rewrite
18+
git checkout -b feature-branch
19+
```
20+
4. **Make Changes**: Implement your changes and ensure they follow the project's coding guidelines. **Do not touch or tamper with the `v0.1.0` branch**, as it is used for deployment.
21+
5. **Test Your Changes**: Run tests (if applicable) to verify that everything works correctly.
22+
6. **Commit Your Changes**: Commit with a clear message describing your changes:
23+
```sh
24+
git commit -m "Add feature XYZ"
25+
```
26+
7. **Push Your Changes**: Push your branch to your forked repository:
27+
```sh
28+
git push origin feature-branch
29+
```
30+
8. **Open a Pull Request**: Go to the original repository and open a Pull Request (PR) targeting the `dev` branch. **Ensure your PR is directed to the `dev` branch, not `master`.**
31+
32+
## Code Guidelines
33+
34+
- Follow consistent formatting and linting rules.
35+
- Write clear and concise commit messages.
36+
- Document your code where necessary.
37+
- Ensure your changes do not break existing functionality.
38+
39+
## Reporting Issues
40+
41+
If you find a bug or have a feature request, please [open an issue](https://github.com/CookethOrg/Cooketh-Flow/issues) with a clear description and any relevant details.
42+
43+
## Community Guidelines
44+
45+
- Be respectful and inclusive.
46+
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md).
47+
- Help others by reviewing and discussing pull requests.
48+
49+
## Governance
50+
[Cooketh Flow](https://github.com/CookethOrg/Cooketh-Flow) is led by [Subroto Banerjee](https://github.com/TeeWrath) as BDFL, who makes final decisions on the project’s direction. Contributors are encouraged to share ideas via GitHub Issues, but the BDFL reserves the right to guide the roadmap.
51+
52+
## License
53+
54+
By contributing, you agree that your contributions will be licensed under the same license as Cooketh Flow.
55+
56+
---
57+
We appreciate your contributions! ❤️ Happy coding!

0 commit comments

Comments
 (0)