Contributing to the pylyrics2 project

Contribution to the project is always welcomed, and appreciated.We learn together right !! This document outlines the way in which one can propose changes/modifications to the pylyrics2 project.

Fixing typo

Grammatical errors or typos in documentation can be edited directly using the GitHub web interface, so long as the changes are made in the source file.

Prerequisites

Before you make a substantial pull request, you should always report an issue and make sure someone from the team agrees to the change. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.

How to Contribute

The pylyrics2 follows GitHub workflow. The steps we are going to follow to contribute to this project are:

  • Create a branch.

  • Commit changes.

  • Create a pull request.

  • One contributor should check the changes and approve them.

  • Finally, merge the pull request.

However If you are a new contributor to the project, visit : pylyrics2 and click the ‘Fork’ icon to get a copy of the project.

1. Clone the repository locally:

git clone https://github.com/UBC-MDS/pylyrics.git

2. Add the upstream repository:

git clone git remote add upstream https://github.com/UBC-MDS/pylyrics

3. Create a branch with a suitable name. E.g branch name ‘test’:

git checkout -b test

Commit locally your progress with an proper commit message. Make sure that the code should follow the PEP8 style guide. Kindly give self explanatory commit messages.

Create a pull request in the Github website using the green button.

Finally the pull must be aproved by at least one of the core team members before merging to the main branch.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Attribution

These contributing guidelines are adapted from the Attribution

Contacts:

  1. Abhiket Gaurav

  2. Artan Zandian

  3. Manju Abhinandana Kumar

  4. Macy Chan