Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

86 lines (66 loc) · 2.89 KB

Contributing to BiteBooker

Thank you for your interest in contributing to BiteBooker! Your contributions are essential to improving the project and making it more robust and user-friendly. Below are the guidelines to help you contribute effectively.

How to Contribute

1. Fork the Repository

  • Navigate to the BiteBooker repository on GitHub.
  • Click the "Fork" button to create your own copy of the repository.

2. Clone the Forked Repository

  • Clone your forked repository to your local machine: 
    git clone https://github.com/rishibharadwajsai/BiteBooker.git
  • Navigate to the project directory: 
    cd BiteBooker

3. Set Up the Environment

  • Ensure you have Node.js, npm or pnpm, and a MongoDB Atlas account set up.
  • Install dependencies for each component (Admin, Backend, Frontend): 
    cd <component-folder>
pnpm install # or npm install
  • Configure the .env file for the backend with your MongoDB connection details and secret keys.

4. Create a Branch

  • Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name

5. Make Changes

  • Make your desired changes in the appropriate files.
  • Ensure your changes are properly tested.

6. Commit Your Changes

  • Write clear and descriptive commit messages: 
    git add .
git commit -m "Add: Description of your changes"

7. Push Your Changes

  • Push your branch to your forked repository: 
    git push origin feature/your-feature-name

8. Submit a Pull Request

  • Navigate to the original BiteBooker repository.
  • Click "New Pull Request" and follow the prompts to submit your changes.

Contribution Guidelines

  1. Issues:

    • Before starting work on a feature or bug fix, check the Issues tab to see if it has already been reported.
    • If not, open a new issue with a clear description.

  2. Pull Requests:

    • Ensure your pull request is linked to a specific issue (if applicable).
    • Provide a clear and concise description of the changes in your pull request.
    • Make sure your pull request passes all tests and does not break existing functionality.

  3. Testing:

    • Test your changes thoroughly before submitting a pull request.
    • If possible, add test cases for your new features or bug fixes.

  4. Coding Standards:

    • Follow the project’s coding style for consistency.
    • Use descriptive names for variables and functions.

Getting Help

If you have questions or need help, feel free to open a discussion or issue in the repository. You can also contact the project owner at rishi.lella123@gmail.com.

We appreciate your contributions and efforts in improving BiteBooker! 🎉