Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

97 lines (65 loc) · 4.1 KB
Raw

Contributing to Foody-Monk

Welcome! We're excited that you're interested in contributing to our food ordering app. This document outlines the guidelines and information you need to know to contribute effectively.

Table of Contents

  1. Getting Started
  2. How to contribute
  3. Development Setup
  4. Contribution Guidelines
  5. Pull Request Process
  6. Code Style
  7. Testing
  8. Issue Tracking
  9. Contact
  10. License

Getting Started

To get started with contributing to the project, you'll need to follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Install the necessary dependencies.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your contribution: git checkout -b feature/my-contribution.
  3. Install the project dependencies using npm ci to ensure a clean and reproducible installation.
  4. Make your desired changes or add new features.
  5. Commit your changes with clear and descriptive commit messages.
  6. Push your changes to your branch: git push origin feature/my-contribution.
  7. Open a pull request (PR) against the main branch of the main repository.
  8. Ensure that your PR description clearly explains the purpose and scope of your contribution.
  9. Be responsive to any feedback or questions requested during the review process.
  10. Once your PR is approved, it will be merged into the main repository.

Development Setup

Our application is built using the MERN (MongoDB, Express.js, React.js, Node.js) stack. Please ensure you have the following tools installed on your local machine:

After installing the necessary dependencies, run the following command to start the development server:

  npm run dev

The server will run on http://localhost:1234.

Contribution Guidelines

Please adhere to the following guidelines when making contributions:

  1. Before starting work on a new feature or bug fix, create a new branch from the develop branch with a descriptive name.
  2. Make your changes and ensure they follow the project's coding style guidelines.
  3. Write clear, concise, and meaningful commit messages.
  4. Keep your pull requests focused and include a description of the changes made.
  5. When submitting a pull request, ensure that it addresses an open issue or create a new issue to discuss the changes with the maintainers.
  6. Be open to feedback and iterate on your changes based on the feedback received.

Pull Request Process

Follow these steps to submit a pull request:

  1. Push your changes to your forked repository.
  2. Open a pull request against the develop branch of the main repository.
  3. Include a detailed description of the changes made.
  4. Assign the pull request to the relevant reviewers or maintainers.
  5. Wait for feedback or approval before merging.

Code Style

We follow a consistent code style in our project to maintain readability and consistency. Please make sure to follow the existing code style conventions and guidelines.

Testing

We highly encourage writing tests for new features or bug fixes to ensure code quality. Use appropriate testing frameworks for both the frontend (React) and backend (Node.js/Express) components of the application.

Issue Tracking

We use GitHub Issues to track bugs, feature requests, and other tasks. If you encounter any issues or have a feature request, please open a new issue on the main repository.

Contact

If you have any questions or need assistance, feel free to reach out to the maintainers or contributors through the communication channels provided in the project's documentation.

License

The project is licensed under the MIT License. By contributing to this project, you agree to make your contributions available under this license.

Thank you for your interest in contributing to our food ordering app. We appreciate your help in making it better!

Happy coding!