Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

57 lines (43 loc) · 2.42 KB

CONTRIBUTING.md

Contributing to Cooketh Flow

Thank you for your interest in contributing to Cooketh Flow! 🚀 We welcome contributions of all kinds, including code, documentation, bug reports, and feature suggestions.

How to Contribute

  1. Fork the Repository: Click the Fork button at the top of the repository page to create your own copy.
  2. Clone Your Fork: Clone the repository to your local machine: 
    git clone https://github.com/your-username/Cooketh-Flow.git
cd Cooketh-Flow
  3. Create a Branch: Create a new branch for your changes from the rewrite branch: 
    git checkout rewrite
git checkout -b feature-branch
  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.
  5. Test Your Changes: Run tests (if applicable) to verify that everything works correctly.
  6. Commit Your Changes: Commit with a clear message describing your changes: 
    git commit -m "Add feature XYZ"
  7. Push Your Changes: Push your branch to your forked repository: 
    git push origin feature-branch
  8. Open a Pull Request: Go to the original repository and open a Pull Request (PR) targeting the rewrite branch. Ensure your PR is directed to the rewrite branch, not v0.1.0.

Code Guidelines

  • Follow consistent formatting and linting rules.
  • Write clear and concise commit messages.
  • Document your code where necessary.
  • Ensure your changes do not break existing functionality.

Reporting Issues

If you find a bug or have a feature request, please open an issue with a clear description and any relevant details.

Community Guidelines

  • Be respectful and inclusive.
  • Follow the Code of Conduct.
  • Help others by reviewing and discussing pull requests.

Governance

Cooketh Flow is led by Subroto Banerjee 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.

License

By contributing, you agree that your contributions will be licensed under the same license as Cooketh Flow.

We appreciate your contributions! ❤️ Happy coding!