-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #203 from Meetjain1/patch-1
Create CONTRIBUITING.md
- Loading branch information
Showing
1 changed file
with
146 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| <h1 align="center">✨ Contributors Guide ✨</h1> | ||
| <h3 align="center">Welcome to Our project! 😍<br> We greatly appreciate your willingness to contribute.😊 <br>This guide will help you get started with the project and make your contributions.</h3> | ||
|
|
||
|  | ||
|
|
||
|
|
||
| This document provides instructions on how to set up and build the project locally. | ||
| This project is a clothing order website that allows user to add products , list their own products, make dashboard of seller | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, ensure you have the following installed on your local machine: | ||
|
|
||
| - Node.js (v14.x or later) | ||
| - npm (Node Package Manager v6.x or later) | ||
|
|
||
| ## Table of Contents | ||
| - [Setup](#Setup) | ||
| - [Contributing Guidelines](#contributing-guidelines) | ||
| - [Getting Started](#getting-started) | ||
| - [Issue Management](#issue-management) | ||
| - [Communication and Collaboration](#communication-and-collaboration) | ||
| - [Deadline and Completion](#deadline-and-completion) | ||
| - [Quality and Learning](#quality-and-learning) | ||
|
|
||
| ## Setup | ||
|
|
||
| Follow these steps to set up the project locally: | ||
|
|
||
| 1. Clone the repository to your local machine: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/mohitparmar1/Shopy.git | ||
| ``` | ||
|
|
||
| 2. Navigate to the project directory: | ||
|
|
||
| ```bash | ||
| cd SHOPY | ||
| ``` | ||
| 3. Install project dependencies: | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ```bash | ||
| npm install vite | ||
| ``` | ||
|
|
||
| 4. Start the development server and run the app | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ## Contributing Guidelines | ||
|
|
||
| Before diving into the learning resources, please familiarize yourself with the following contributing guidelines: | ||
|
|
||
| - Participants/contributors must comment on issues they wish to work on. | ||
| - Issues will be assigned on a first-come, first-serve basis by mentors or the Project Administrator (PA). | ||
| - Participants can open new issues using the provided template, but these need verification and labeling by a mentor or PA. | ||
| - Ensure issues are assigned to you before starting work. | ||
| - Each participant can work on a maximum of one issue at a time. | ||
| - Don't work on issues already assigned to others. | ||
| - Discuss issues with the team before starting work. | ||
| - Explain your approach to solving any issue in the comments for better understanding. | ||
| - Pull requests will be merged after review by a mentor or PA. | ||
| - Create PRs from branches other than `main`. | ||
| - Include a descriptive summary of your work in the PR description. | ||
| - Use the format `Fixes: issue number` in your commit message when creating a pull request. | ||
| - Complete assigned issues within the specified deadline. Failure to do so may result in reassignment. | ||
| - Follow project guidelines and coding style. | ||
| - Aim for structured and optimized code. | ||
| - Mistakes are allowed and part of the learning process! | ||
| ## Getting Started | ||
| To contribute to the project, follow these steps: | ||
| 1. **Fork the Repository**: Start by forking the repository to your GitHub account. | ||
| 2. **Clone the Repository**: Clone your forked repository to your local machine. | ||
| 3. **Choose an Issue**: Comment on an issue you'd like to work on or open a new one following the guidelines. | ||
| 4. **Set Up Development Environment**: Refer to the project's development guidelines for setting up your development environment. | ||
| 5. **Start Working**: Once the issue is assigned to you, start working on it following your chosen approach. | ||
| 6. **Submit a Pull Request**: After completing your work, submit a pull request from your branch for review. | ||
| ## Issue Management | ||
| Issues are managed as follows: | ||
| - Participants must comment on issues they wish to work on. | ||
| - Issues will be assigned on a first-come, first-serve basis. | ||
| - Participants can open new issues using the provided template, but these need verification and labeling by a mentor or PA. | ||
| - Ensure issues are assigned to you before starting work. | ||
| - Each participant can work on a maximum of one issue at a time. | ||
| - Don't work on issues already assigned to others. | ||
| - Discuss issues with the team before starting work. | ||
|
|
||
| ## Communication and Collaboration | ||
|
|
||
| Effective communication and collaboration are crucial for successful contributions: | ||
|
|
||
| - Discuss issues with the team before starting work. | ||
| - Explain your approach to solving any issue in the comments for better understanding. | ||
|
|
||
| ## Deadline and Completion | ||
|
|
||
| Ensure timely completion of assigned tasks: | ||
|
|
||
| - Complete assigned issues within the specified deadline. | ||
| - Failure to meet the deadline may result in reassignment. | ||
|
|
||
| ## Quality and Learning | ||
|
|
||
| Learnings: | ||
|
|
||
| - Client-Side Development: Understanding how to build a user-friendly interface using React and TailwindCSS. | ||
| - Server-Side Development: Utilizing Node.js and Express for server-side logic and API integrations. | ||
| - Git Workflow: Understanding the Git workflow for contributing to open-source projects, including forking, branching, committing, and creating pull requests. | ||
|
|
||
| Focus on quality and continuous learning: | ||
|
|
||
| - Follow project guidelines and coding style. | ||
| - Aim for structured and optimized code. | ||
| - Mistakes are allowed and are a part of the learning process! | ||
|
|
||
| Thank you for your contribution!! | ||
|
|
||
|  | ||
|
|
||
| <h2 align="center">Need more help? 🤔</h1> | ||
| <p align="center"> | ||
| You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: <br> | ||
| <a href="https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request">How to create a Issue</a> <br> | ||
| <a href="https://help.github.com/en/github/getting-started-with-github/fork-a-repo">Forking a Repo</a> <br> | ||
| <a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository">Cloning a Repo</a> <br> | ||
| <a href="https://opensource.com/article/19/7/create-pull-request-github">How to create a Pull Request</a> <br> | ||
| <a href="https://docs.github.com/get-started">Getting started with Git and GitHub</a> <br> | ||
| </p> | ||
|
|
||
| <h2 align="center">Tip from us 😇</h1> | ||
| <p align="center">Learning and understanding take time, so don't worry at all. We have full confidence in you. You've got this!!</b>! 💪</p> | ||
| <h3 align="center">Show some ❤️ by 🌟 this repository!</h3> | ||
|
|