Skip to content

Latest commit

 

History

History
110 lines (62 loc) · 4.26 KB

CONTRIBUTING.md

File metadata and controls

110 lines (62 loc) · 4.26 KB

Contributing

⭐ Thank you for your interest in contributing!!

Here’s how you can contribute to this repository

Found a bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a feature?

So, you've got an awesome feature in mind? Throw it over to us by creating an issue on our GitHub Repo.

If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues.

How do I make a code contribution?

Good first issues

Are you new to open source contribution? Wondering how contributions work in our project? Here's a quick rundown.

Find an issue that you're interested in addressing, or a feature that you'd like to add. You can use this view which helps new contributors find easy gateways into our project.

Step 1: Make a fork

Fork the repository to your GitHub organization. This means that you'll have a copy of the repository under your-GitHub-username/repository-name.

Step 2: Clone the repository to your local machine

git clone https://github.com/<your-GitHub-username>/Music-Recommendation-Using-Facial-Expressions

Step 3: Make your changes

Now that everything is set up and works as expected, you can get start developing or update the code with your bug fix or new feature.

Step 4: Add the changes that are ready to be committed

Stage the changes that are ready to be committed:

git add .

Step 7: Commit the changes (Git)

Commit the changes with a short message. (See below for more details on how we structure our commit messages)

git commit -m "<type>(<package>): <subject>"

Step 8: Push the changes to the remote repository

Push the changes to the remote repository using:

git push origin <branch-name-here>

Step 9: Create Pull Request

In GitHub, do the following to submit a pull request to the upstream repository:

  1. Give the pull request a title and a short description of the changes made. Include also the issue or bug number associated with your change. Explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.

Remember, it's okay if your pull request is not perfect (no pull request ever is). The reviewer will be able to help you fix any problems and improve it!

  1. Wait for the pull request to be reviewed by a maintainer.

  2. Make changes to the pull request if the reviewing maintainer recommends them.

Celebrate your success after your pull request is merged :-)

PR Template

The name and description of a PR is important, because it will eventually become the commit that shows up in main. Here are the guidelines for how to name and describe a PR.

PR name: [Feature Name]

PR description: Keyword #{issue-number} Short summary

For example:

Name: Added Readme File

Description: Fixes #1

Added Readme File for the project

Feature Name

  • A short-form version of the feature you're working on, or, alternatively the location you're making changes. Serves as an easy, at a glance, indicator of what the PR is touching.

Issue Number

  • Following the keyword is the issue number - this is the issue the ticket addresses.

Short Summary

  • This is a short summary of what your commit/PR is doing.

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.

Code of Conduct

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy.

⭐ Happy coding, and we look forward to your contributions!