Contribution Guidelines

We welcome contributions to the Black and White Chef project! Whether you’re fixing bugs, improving documentation, or adding new features, your input is highly valued. Please follow the guidelines below to ensure a smooth contribution process.

Getting Started

  1. Fork the Repository: - Navigate to the project repository on GitHub. - Click the Fork button to create your own copy of the repository.

  2. Clone Your Fork: - Clone your forked repository to your local machine:

    ` git clone https://github.com/YooHyun-Kim/CLAS.git `

  3. Set Up the Development Environment: - Ensure you have Python and any required dependencies installed. - Install dependencies using:

    ` pip install -r requirements.txt `

Coding Standards

  1. Follow PEP 8: - Adhere to Python’s PEP 8 coding style guide. - Use tools like flake8 or black to check and format your code.

  2. Write Clear and Concise Comments: - Document all major functions, classes, and modules. - Use docstrings to describe the purpose and usage of code components.

  3. Ensure Code Quality: - Test your code thoroughly before submission. - Include unit tests for any new features.

Submitting Contributions

  1. Create a New Branch: - Name your branch based on the purpose of your contribution:

    ` git checkout -b feature/add-recipe-search `

  2. Make Your Changes: - Commit your changes with clear and descriptive commit messages:

    ` git commit -m "Add recipe search functionality" `

  3. Push Your Branch: - Push your branch to your forked repository:

    ` git push origin feature/add-recipe-search `

  4. Submit a Pull Request: - Navigate to the original repository and open a pull request. - Provide a detailed description of your changes and the issue they address.

Review and Approval

  • Your pull request will be reviewed by project maintainers.

  • Feedback will be provided, and you may need to make adjustments before approval.

  • Once approved, your changes will be merged into the main repository.

Thank you for contributing to the Black and White Chef project! Together, we can build an amazing platform.