Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

58 lines (34 loc) · 2.32 KB
Raw

Contributing to Coffee-Bean Coffee Shop Website

Welcome to the Coffee-Bean Coffee Shop Website project! We're thrilled that you're interested in contributing. Your help is essential in making our website even more brew-tiful. Before you dive in, please take a moment to review the following guidelines.

How to Contribute

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page to create your copy.

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

    git clone https://github.com/your-username/coffee-bean.git

  3. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your code changes, keeping in mind our project's coding standards.

  5. Test Locally: Test your changes locally to ensure they work as expected.

  6. Commit Your Changes: Commit your changes with clear and concise commit messages.

    git commit -m "Add: Brief description of your changes"

  7. Push to Your Fork: Push your changes to your fork on GitHub.

    git push origin feature/your-feature-name

  8. Open a Pull Request: Create a Pull Request from your forked repository to our main repository, describing your changes and the problem they solve.

  9. Review and Discuss: Participate in the conversation, addressing any feedback or questions from maintainers.

  10. Merge: Once approved, your Pull Request will be merged into the main branch.

Code Style Guidelines

  • Follow consistent coding style, including indentation and naming conventions.
  • Add comments for complex logic to enhance code readability.
  • Make sure your code is free from linting errors.

Reporting Issues

If you find a bug, have a suggestion, or want to discuss something related to the project, please open an issue on the GitHub repository. Be sure to include a clear description and, if applicable, steps to reproduce the issue.

Communication

Feel free to reach out to us through GitHub issues, discussions, or our community forum for any questions or ideas. We're excited to collaborate with you!

Thank you for being a part of Coffee-Bean's coffee-fueled journey. ☕ Happy coding!