Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 4.23 KB

README.md

File metadata and controls

109 lines (71 loc) · 4.23 KB

Forks Stars GitHub contributors

Contribution Guidelines 🏗

1. Make sure to make UI consistency while adding new features to musicify
2. Use the packages which are compatible with our website.
3. Make sure that your code is well documented to be easily readable and understandable, especially in tougher areas.
4. Use the uniform naming convention throughout the codebase.
5. Make sure that the code is as modular as possible.
6. Separate UI and logic part
7. Do not spam unnecessary merge requests.

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your_user_name>/musicify.git

3. Navigate to the project directory and follow this steps for run the musicify application.

cd musicify

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/developer-student-clubs/musicify.git 

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add . 

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on **compare and pull requests**.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15. Voila ❗ You have made a PR to the musicify💥 . Wait for your submission to be accepted and your PR to be merged.

16. Congratulations! You've made your first contribution! 🙌

For further details, click on CONTRIBUTING.md

Code of Conduct

We follow certain guidelines in order to maintain this repository. Please find our code of conduct and read it carefully.

Who are the makers of musicify? 🤓

Prince Dhamecha

Dharmesh Poriya

Parshwa Mehta