-
Notifications
You must be signed in to change notification settings - Fork 35
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 #12 from rajatsinghal02/master
Create Contributing.md
- Loading branch information
Showing
1 changed file
with
65 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,65 @@ | ||
<h1 align="center">Contributors Guide for fusionFLOW⚡</h1> | ||
<h3 align="center">Welcome to our fusionFLOW! Make sure to star this repository😍<br> We appreciate your interest in contributing.😊 <br>This guide will help you get started with the project and make your first contribution.</h3> | ||
|
||
|
||
<h1 align="center">Creating your First Pull Request 🌟</h1> | ||
|
||
--- | ||
|
||
1. Star this repository. | ||
2. Fork this repository. | ||
3. Clone the forked repository. | ||
```bash | ||
git clone https://github.com/<your-github-username>/fusionFLOW.git | ||
``` | ||
|
||
4. Navigate to the project directory. | ||
```bash | ||
cd fusionFLOW | ||
``` | ||
5. Install the dependencies. | ||
```bash | ||
npm install | ||
``` | ||
6. Create a new branch. | ||
```bash | ||
git checkout -b <your_branch_name> | ||
``` | ||
7. Make changes and ensure the app runs correctly. | ||
```bash | ||
npm start | ||
``` | ||
8. Stage your changes and commit. | ||
```bash | ||
git add . | ||
``` | ||
```css | ||
|
||
git commit -m "Added new feature/fixed bug." | ||
``` | ||
|
||
9. Push your local commits to the remote repo. | ||
```bash | ||
git push -u origin <your_branch_name> | ||
``` | ||
|
||
10. Create a Pull Request. | ||
11. Congratulations! 🎉 you've made your contribution. | ||
|
||
|
||
## :zap: Pull Requests Review Criteria 🧲 | ||
|
||
1. Please fill the ***PR Template*** properly while making a Pull Request. | ||
2. Never commit in the `main` branch. | ||
3. Your work must be original, written by you not copied from other resources. | ||
4. You must comment on your code where necessary. | ||
|
||
## :zap: Communication and Support 💬 | ||
- Join the project's communication channels to interact with other contributors and seek assistance. | ||
- If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue. | ||
|
||
## :zap: Code of Conduct 😇 | ||
Please follow our project's code of conduct while contributing.</br>Treat all contributors and users with respect and create a positive and inclusive environment for everyone. | ||
|
||
## :zap: License 📄 | ||
The project is licensed under ***MIT***. Make sure to review and comply with the license terms.</br>We hope this guide helps you get started with contributing to our open-source project. Thank you for your contribution! |