Make Your First Pull Request!
π€ First time contributing? Will help you out.π
Refer to the following articles on the basics of Git and GitHub, in case you are stuck:
If you don't have git on your machine, install it.
π₯ How to Contribute
- Take a look at the Existing Issues or create your own Issues!
- 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 knowing what this Script is all about.
How to make a Pull Request
If you think that you can add a new feature or want to fix a bug. You can start contributing by following the below instructions:
Create a folder at your desire location (usually at your desktop).
Open Git Bash Here
Create a Git repository.
Run command
git init
Fork the repository.
Clone your forked repository of project.
git clone https://github.com/<your_username>/repository_name.git
- Navigate to the project directory.
cd <repository_name>
- Add a reference(remote) to the original repository.
git remote add upstream https://github.com/repository_owner/repository_name.git
- Check the remotes for this repository.
git remote -v
- Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.
git pull upstream main
- Create a new branch (prefer a branch name that relates to your assigned issue).
git checkout -b <YOUR_BRANCH_NAME>
- Perform your desired changes to the code base.
- Check your changes.
git status
git diff
- Stage your changes.
git add . <\files_that_you_made_changes>
- Commit your changes.
git commit -m "relavant message"
- Push the committed changes in your feature branch to your remote repository.
git push -u origin <your_branch_name>
To create a pull request, click on
compare and pull requests
.Add appropriate title and description to your PR explaining your changes.
Click on
Create pull request.
Congratulations
If you have any doubts please let me know in the comments.
Comments
Post a Comment