Skip to content

Latest commit

 

History

History
70 lines (34 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

70 lines (34 loc) · 2.84 KB
Raw

Contributing to FlavorFleet 🍔🌮🍰

Thank you for considering contributing to FlavorFleet! We welcome your contributions to help make this food website even better. By contributing, you are helping us create a more delightful experience for food lovers around the world.

How Can You Contribute?

There are several ways you can contribute to FlavorFleet:

  1. Bug Reports: If you encounter a bug while using FlavorFleet, please report it. Be sure to include details such as the steps to reproduce the bug and your environment setup.

  2. Feature Requests: If you have a great idea for a new feature or enhancement, feel free to suggest it. We value your input in making FlavorFleet more versatile.

  3. Code Contributions: If you are a developer and want to contribute code to the project, please follow our development guidelines.

  4. Documentation Improvements: Documentation is crucial. If you find discrepancies, outdated information, or have suggestions for improvement, please let us know.

  5. Testing: Help us improve the stability and reliability of FlavorFleet by testing new features and fixes. Your feedback is invaluable.

Development Guidelines

To contribute code to FlavorFleet, follow these steps:

  1. Fork the FlavorFleet repository to your own GitHub account.

  2. Create a new branch with a descriptive name for your feature or bug fix.

  3. Make your changes in the new branch.

  4. Commit your changes with clear and concise messages.

  5. Push your changes to your forked repository.

  6. Create a pull request (PR) to the main FlavorFleet repository. Include a detailed description of your changes and why they are necessary.

  7. Be responsive to feedback on your PR and be prepared to make additional changes if needed.

  8. Once your PR is approved, it will be merged into the main branch.

Code Style and Guidelines

Please adhere to the following guidelines when contributing code:

  • Follow the coding style and formatting of the existing codebase.

  • Write clear and concise code with meaningful variable and function names.

  • Document your code using comments, especially for complex logic or non-obvious decisions.

  • Write unit tests for your code when applicable.

Getting Help

If you have questions or need assistance with the contribution process, feel free to reach out to our maintainers. We're here to help and support you throughout the journey.

Code of Conduct

Please note that by contributing to FlavorFleet, you are agreeing to follow our Code of Conduct. We are committed to creating a welcoming and inclusive environment for all contributors.

Licensing

By contributing to FlavorFleet, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to FlavorFleet and being a part of our community! 🙌