Skip to content

Latest commit

 

History

History
102 lines (73 loc) · 4.43 KB

Contributing.md

File metadata and controls

102 lines (73 loc) · 4.43 KB

⭐ First time contributing? We will help you out.

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

💥 Contribution

PRs WelcomeCodeFactor Open Source Love

  • Take a look at the Existing Issues or create your own Issues!
  • Participants have to comment on issues they would like to work on, and mentors will assign you.
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Read the Code of Conduct
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this Script is all about.
  • You can discuss with other people working on the same project about your idea on discord.
  • Issues will be assigned on a first-come, first-serve basis.
  • Participants can also open their issues, but it needs to be verified by a mentor.
  • Each participant will be assigned 2 issues (max) at a time to work.
  • Participants/contributors have max 4 days to complete issues. After that issues will be assigned to others.
  • Participants are expected to follow project guidelines and coding style.
  • It might take a maximum of 2 days to review your pull request. Please have patience.

⭐HOW TO MAKE A PULL REQUEST:

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository. Open terminl and type:

git clone https://github.com/<your-github-username>/Rescue

3. Navigate to the project directory.

cd Rescue

4. Add the original repo as the upstream.

git remote add upstream https://github.com/swapnilsparsh/Rescue.git

5. Before creating the branch make sure the master branch of forked repo is even with the master branch of original repo.

# Pull code from original repo
git pull upstream master

# Update the forked repo
git push origin master

6. Create a new branch.

git checkout -b <your_branch_name>

7. Make changes in source code.

8. Make current branch even with the master branch

git pull origin master

9. Resolve all the conflicts

10. Stage your changes and commit

# Add changes to Index
git add .

# Commit to the local repo
git commit -m "<your_commit_message>"

11. Push your local commits to the remote repo.

git push origin <your_branch_name>

12. Create a PR !

13. Congratulations! Sit and relax, you've made your contribution to Rescue project.

💥 Issues:

For major changes, you are welcomed to open an issue and discuss about what you would like to contribute. Enhancements will be appreciated.


built by developers built with love