Skip to content

Latest commit

 

History

History
111 lines (91 loc) · 4.94 KB

CONTRIBUTING-GUIDE.md

File metadata and controls

111 lines (91 loc) · 4.94 KB
Raw

Contributing Guidelines

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.

Table Of Contents

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
Make sure to read it here: CODE_OF_CONDUCT.md

By participating, you are expected to uphold this code. For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

Submitting Contributions👩‍💻👨‍💻

Below you will find the process and workflow used to review and merge your changes.

Step 0 : Find an issue 🔍

  • 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.
  • Note : Every change in this project should/must have an associated issue.

issue

Step 1 : Fork the Project 🍴

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
$ git clone https://github.com/<your-username>/Musicophilia
# Navigate to the project directory.
$ cd Musicophilia
$ git remote add upstream https://github.com/nilisha-jais/Musicophilia

This is how you can fork the repository. fork

  • If you have already forked the project, update your copy before working.
$ git remote update
$ git checkout <branch-name>
$ git rebase upstream/<branch-name>

Step 2 : Branch 🔖

Create a new branch. Use its name to identify the issue your addressing.

# It will create a new branch with name Branch_Name and switch to that branch
$ git checkout -b Branch_Name

Step 3 : Work on the issue assigned 📕

  • Work on the issue(s) assigned to you.
  • Add all the files/folders needed.
  • After you've made changes or made your contribution to the project add changes to the branch you've just created by:
# To add all new files to branch Branch_Name
$ git add .

# To add only a few files to Branch_Name
$ git add <some files>

Step 4 : Commit

  • To commit give a descriptive message for the convenience of reviewer by:
# This message get associated with all files you have changed
$ git commit -m "message"
  • NOTE: A PR should have only one commit. Multiple commits should be squashed.

Step 5 : Work Remotely

  • Now you are ready to your work to the remote repository.
  • When your work is ready and complies with the project conventions, upload your changes to your fork:
# To push your work to your remote repository
$ git push -u origin Branch_Name
  • Here is how your branch will look.

branch

Step 6 : Pull Request 🎣

  • Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.

pullrequest

- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳

Need more help?🤔

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

Tip from us😇

It always takes time to understand and learn. So, do not worry at all. We know you have got this!💪