From b76147bed5ba5ed1ac971e06585ae98ccf798456 Mon Sep 17 00:00:00 2001 From: ylorenzana Date: Sat, 28 Oct 2017 16:49:54 -0400 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..78fd251 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# youtube-playlist-sorter +--- +Thank you for taking your time to contribute! +These are a set of guidelines to follow when contributing to youtube-playlist-sorter. + +# How Can I Contribute? +--- +### Reporting Bugs +Create a new [issue](https://guides.github.com/features/issues/) in the repository and explain the problem, and include these details: +* Use a clear and descriptive title for the issue +* Describe the steps to reproduce the problem +* Explain what you expected to happen instead and why + +### Suggesting Enhancements +Create a new [issue](https://guides.github.com/features/issues/) in the repository. Provide this information: +* Use a clear and descriptive title for the suggestion +* Describe step-by-step the suggested enhancement +* Explain why you think the enhancement would be useful + +### Pull Requests +You can start by looking through the current [open issues](https://github.com/jaydp17/youtube-playlist-sorter/issues). +If you are first-timer or are unsure how to create pull requests in github, you can follow this [guide](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) for instructions. +# Styling Guide +--- +### Git Commit Messages +* Use the present tense ("Add feature" not "Added feature") +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") + +### Javascript Style +youtube-playlist-sorter uses [Prettier](https://github.com/prettier/prettier). + + +# License +--- +[MIT](https://github.com/jaydp17/youtube-playlist-sorter/blob/master/LICENSE) \ No newline at end of file