First off, thank you for considering contributing to our project! Your help is greatly appreciated.
If you find a bug in the project, please submit an issue. When reporting a bug, please include:
- A clear and descriptive title.
- A detailed description of the problem, including steps to reproduce.
- Any relevant logs, screenshots, or other information that could help diagnose the problem.
We welcome suggestions for improvements and new features. When suggesting an enhancement, please include:
- A clear and descriptive title.
- A detailed description of the proposed change.
- Any relevant context or reasoning for the enhancement.
If you would like to contribute code, follow these steps:
- Fork the repository: Create a fork of the repository on GitHub.
- Clone your fork: Clone your fork to your local machine.
git clone https://github.com/<your-username>/food-delivery-multivendor.git cd food-delivery-multivendor
- Create a new branch: Create a new branch for your feature or bugfix.
git checkout -b feature-or-bugfix-description
- Make your changes: Make your changes to the code.
- Test your changes: Ensure your changes work as expected and do not introduce any issues.
- Commit your changes: Commit your changes with a descriptive commit message.
git add . git commit -m "Description of the feature or bugfix"
- Push your changes: Push your changes to your fork.
git push origin feature-or-bugfix-description
- Submit a pull request: Create a pull request from your fork to the main repository. Include a detailed description of your changes.
To ensure consistency in the codebase, please follow these guidelines:
- Code Style: Follow the existing code style in the project.
- Comments: Write clear and concise comments for complex code sections.
- Tests: Write tests for new features and bug fixes.
By participating in this project, you agree to abide by our Code of Conduct.
Ensure you have the following installed:
- Node.js (version 14.0 to 16.0)
- npm or yarn
-
Clone the repository:
git clone https://github.com/enatega/food-delivery-multivendor.git cd food-delivery-multivendor
-
Install dependencies:
npm install # or yarn install
-
Run the development server:
npm start # or yarn start