Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 2.6 KB
Raw

Contributing

Thanks for being willing to contribute!

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Check if the feature was not already reported by searching on GitHub under Issues.

  • If you're unable to find an issue addressing the feature, open a new one. Be sure to include a title and clear description, as much relevant information as possible, along with the current and expected behavior.

  • If the sugestion recieved a positive feedback, you can start writing code.

Project setup

  1. Fork and clone the repo
  2. Run npm install to install dependencies
  3. Create a branch for your PR with git checkout -b pr/your-branch-name

Tip: Keep your master branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/GabrielDuarteM/webplayer-hotkeys.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Committing and Pushing changes

Please make sure to run the ci script before you commit your changes. You can run npm run ci to check that before commiting.

Help needed

Please checkout the the open issues

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks! ❤️ ❤️ ❤️