-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add contributing templates & document
* add templates for issues & prs * add contributing document * update readme - add windows disclaimer - add toc - add contributing section - add disclaimer section Resolves: #14
- Loading branch information
Showing
4 changed files
with
248 additions
and
3 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,47 @@ | ||
<!-- Thank you for contributing! --> | ||
<!-- Please fill out the issue template according to the type of issue that you | ||
are creating! --> | ||
|
||
## Description | ||
|
||
<!-- Type: `Feature Request` --> | ||
<!-- Type: `Bug` --> | ||
<!-- Type: `Discussion` --> | ||
A clear and concise description of what the issue is about. | ||
|
||
## To Reproduce | ||
|
||
<!-- If this isn't a BUG issue, please write: N/A --> | ||
|
||
* Platform/Environment: MacOS, Linux | ||
* Node Version: `<node version>` | ||
* AnimeGO-DL version: `animego-dl --version` | ||
* YT-DLP version: `yt-dlp --version` | ||
* Docker version: `if applicable` | ||
|
||
|
||
<!-- | ||
Steps: | ||
Steps to reproduce here .... | ||
--> | ||
|
||
## Files | ||
|
||
<!-- If this is not applicable, please write: N/A --> | ||
A list of relevant files for this issue. This will help people navigate the project and offer some clues of where to start. | ||
|
||
## Screenshots | ||
|
||
<!-- Feel free to omit this if not applicable --> | ||
 | ||
|
||
## Tasks | ||
|
||
<!-- Feel free to omit this if not applicable --> | ||
Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at. | ||
- [ ] Task 1 | ||
- [ ] Task 2 | ||
- [ ] Task 3 | ||
|
||
Remember to use relevant labels :pray: |
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,60 @@ | ||
<!--- Provide a general summary of your changes in the title above --> | ||
|
||
## Description | ||
|
||
<!--- Describe your changes in detail --> | ||
|
||
## Related Issues | ||
|
||
<!--- Please list all issues related to this PR: --> | ||
|
||
- [#1](#1) | ||
|
||
## Motivation and Context | ||
|
||
<!--- Why is this change required? What problem does it solve? --> | ||
|
||
## How To Test It? | ||
|
||
<!--- Please provide context for reviewers about how to test the PR | ||
For example: | ||
- Environment | ||
- Node Version (or docker version if applicable) | ||
- Steps to reach view / reproduce issue | ||
--> | ||
|
||
**Environment:** `Linux` <!-- Linux, MacOS, Windows, Docker --> | ||
**Node Version:** `v16.13.1` <!-- node --version --> | ||
**YT-DLP Version:** `2021.12.27` <!-- yt-dlp --version --> | ||
|
||
**Steps**: | ||
<!-- Steps to test --> | ||
|
||
## Visual reference | ||
|
||
<!--- | ||
Please include screenshots, gifs or recordings. If your changes are not visual, write "No visual changes made". | ||
For example: if this is a cli UI fix, provide relevant screenshots or recordings | ||
--> | ||
|
||
## Checklist | ||
|
||
<!--- | ||
Go over all the following points and: | ||
- put an `x` in all the boxes that apply. ([x]) | ||
- put n/a in all the boxes that do not apply. ([n/a]) | ||
Please be sure to add the name of the device you tested and whether it was a simulator or physical device. | ||
For example: | ||
- [x] I have tested on a supported environment: Linux | ||
- [x] I have tested using the project's Node version: `v16.13.1` | ||
- [n/a] I have added tests to cover my changes. | ||
- [n/a] I have updated the documentation accordingly. | ||
--> | ||
|
||
- [ ] I have tested on a supported environment: ENTER_ENV_HERE - MacOS?, Linux? | ||
- [ ] I have tested using the project's Node version: `v16.13.1` | ||
- [ ] I have added tests to cover my changes. | ||
- [ ] I have updated the documentation accordingly. |
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,121 @@ | ||
# Contributing | ||
|
||
Hi! :wave: Thank you for contributing to the project, I hope you have fun! | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue (*preferred*), | ||
email, or any other method with the owners of this repository before making a change. | ||
|
||
Please note we have a Code of Conduct, please follow it in all your interactions with the project. | ||
|
||
## Pull Request Process | ||
|
||
1. Please use correct labels for the status of your PR (ie. `Work in Progress`, | ||
`Ready for Review`, `Help Wanted` ... etc). | ||
2. Ensure any existing test pipelines are passing before marking the Pull | ||
Request as `Ready for Review`. | ||
- New tests, and improving test cases are welcome! Please make sure an | ||
additional unit tests are passing as well. | ||
3. Update the README.md with details of changes to the interface, this includes new | ||
variables, supported environments, exposed ports, useful file locations and command (or container) parameters. | ||
4. *If Applicable* - Increase the version numbers in any examples files and the README.md to the new version that this | ||
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). | ||
5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you | ||
do not have permission to do that, you may request the second reviewer to merge it for you. | ||
|
||
## Commit Style | ||
|
||
To faciliate an easy merging process (and possible rollbacks -- in the event of introducted | ||
crashes/bugs), it is desired to take an atomic commit approach: each commit | ||
should pertain to a single fix or feature. There is room for compromise, if it | ||
makes sense, but too many commits should be avoided. You can refer to the | ||
following for more on atomic commit methodology: | ||
* [https://www.freshconsulting.com/insights/blog/atomic-commits/](https://www.freshconsulting.com/insights/blog/atomic-commits/) | ||
* [https://dev.to/paulinevos/atomic-commits-will-help-you-git-legit-35i7](https://dev.to/paulinevos/atomic-commits-will-help-you-git-legit-35i7) | ||
|
||
This project loosely follows the [angular commit style](https://gist.github.com/brianclements/841ea7bffdb01346392c). As | ||
a **TL:DR**, the general commit structure should look like the following: | ||
``` | ||
doc(readme): update contributing information | ||
This commit updates the contributing markdown link | ||
Resolves: #14 | ||
``` | ||
|
||
## Code of Conduct | ||
|
||
### Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
### Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
### Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
### Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
### Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project owner at | ||
`vincent.aceto@gmail.com`. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. I, @vinnyA3 and the | ||
Project Team, is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
### Attribution | ||
|
||
This Code of Conduct is adapted from @PurpleBooth's contributing [template](https://gist.github.com/PurpleBooth/b24679402957c63ec426), | ||
which was adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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