-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |