Add GitHub PR + issue templates (#242)
This commit is contained in:
parent
bd71ebf916
commit
f05c8e6285
5 changed files with 200 additions and 0 deletions
38
.github/ISSUE_TEMPLATE/BUG.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/BUG.md
vendored
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
---
|
||||||
|
name: Report a bug with pyiCloud
|
||||||
|
---
|
||||||
|
<!-- READ THIS FIRST:
|
||||||
|
- Make sure you are running the latest version of pyiCloud before reporting an issue: https://github.com/picklepete/pyicloud/releases
|
||||||
|
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
|
||||||
|
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
|
||||||
|
-->
|
||||||
|
## The problem
|
||||||
|
<!--
|
||||||
|
Describe the issue you are experiencing here to communicate to the maintainers.
|
||||||
|
Tell us what you were trying to do and what happened instead.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
<!--
|
||||||
|
Provide details about the versions you are using, which helps us to reproduce
|
||||||
|
and find the issue quickly.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- pyiCloud release with the issue (`pip show pyicloud`):
|
||||||
|
- Last working pyiCloud release (if known):
|
||||||
|
- Service causing this issue:
|
||||||
|
- Python version (`python -V`):
|
||||||
|
- Operating environment (project deps/Docker/Windows/etc.):
|
||||||
|
|
||||||
|
## Traceback/Error logs
|
||||||
|
<!--
|
||||||
|
If you come across any trace or error logs, please provide them.
|
||||||
|
-->
|
||||||
|
|
||||||
|
```shell
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Additional information
|
||||||
|
|
33
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
---
|
||||||
|
name: Request a feature to pyiCloud
|
||||||
|
---
|
||||||
|
<!-- READ THIS FIRST:
|
||||||
|
Make sure you are running the latest version of pyiCloud before requesting a feature: https://github.com/picklepete/pyicloud/releases
|
||||||
|
-->
|
||||||
|
## The request
|
||||||
|
<!--
|
||||||
|
Describe the request you are wondering here to communicate to the maintainers.
|
||||||
|
Tell us what you are trying to do and why you can't now.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
<!--
|
||||||
|
Provide details about the versions you are using, which helps us to find a quicker way to help you.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- pyiCloud version (`pip show pyicloud`):
|
||||||
|
- Python version (`python -V`):
|
||||||
|
- Operating environment (project deps/Docker/Windows/etc.):
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
<!--
|
||||||
|
Put an `x` in the boxes that apply.
|
||||||
|
You can also fill these out after creating the support request via the UI.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- [ ] I've looked informations into the README.
|
||||||
|
- [ ] I've looked informations into the pyiCloud's code.
|
||||||
|
|
||||||
|
## Additional information
|
||||||
|
|
49
.github/ISSUE_TEMPLATE/SUPPORT.md
vendored
Normal file
49
.github/ISSUE_TEMPLATE/SUPPORT.md
vendored
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
---
|
||||||
|
name: Need help with pyiCloud
|
||||||
|
---
|
||||||
|
<!-- READ THIS FIRST:
|
||||||
|
- Make sure you are running the latest version of pyiCloud before requesting a support: https://github.com/picklepete/pyicloud/releases
|
||||||
|
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
|
||||||
|
DO NOT DELETE ANY TEXT from this template! Otherwise, your request may be closed without comment.
|
||||||
|
-->
|
||||||
|
## The problem
|
||||||
|
<!--
|
||||||
|
Describe the issue you are experiencing here to communicate to the maintainers.
|
||||||
|
Tell us what you were trying to do and what happened instead.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
<!--
|
||||||
|
Provide details about the versions you are using, which helps us to reproduce
|
||||||
|
and find the issue quickly.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- pyiCloud release with the issue (`pip show pyicloud`):
|
||||||
|
- Last working pyiCloud release (if known):
|
||||||
|
- Service causing this issue:
|
||||||
|
- Python version (`python -V`):
|
||||||
|
- Operating environment (project deps/Docker/Windows/etc.):
|
||||||
|
|
||||||
|
|
||||||
|
## Traceback/Error logs
|
||||||
|
<!--
|
||||||
|
If you come across any trace or error logs, please provide them.
|
||||||
|
-->
|
||||||
|
|
||||||
|
```shell
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
<!--
|
||||||
|
Put an `x` in the boxes that apply.
|
||||||
|
You can also fill these out after creating the support request via the UI.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- [ ] I've looked informations into the README.
|
||||||
|
- [ ] I've looked informations into the pyiCloud's code.
|
||||||
|
- [ ] I've looked informations in Google.
|
||||||
|
|
||||||
|
## Additional information
|
||||||
|
|
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: I'm unsure where to go
|
||||||
|
url: https://gitter.im/picklepete/pyicloud
|
||||||
|
about: If you are unsure where to go, then joining our chat is recommended; Just ask!
|
75
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
75
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,75 @@
|
||||||
|
<!--
|
||||||
|
You are amazing!
|
||||||
|
Thanks for contributing to our project <3
|
||||||
|
Please, DO NOT DELETE ANY TEXT from this template! (unless instructed).
|
||||||
|
-->
|
||||||
|
## Breaking change
|
||||||
|
<!--
|
||||||
|
If your PR contains a breaking change for existing users, it is important
|
||||||
|
to tell them what breaks, how to make it work again and why we did this.
|
||||||
|
This piece of text is published with the release notes, so it helps if you
|
||||||
|
write it towards our users, not us.
|
||||||
|
Note: Remove this section if this PR is NOT a breaking change.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## Proposed change
|
||||||
|
<!--
|
||||||
|
Describe the big picture of your changes here to communicate to the
|
||||||
|
maintainers why we should accept this pull request. If it fixes a bug
|
||||||
|
or resolves a feature request, be sure to link to that issue in the
|
||||||
|
additional information section.
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
<!--
|
||||||
|
What type of change does your PR introduce to pyiCloud?
|
||||||
|
NOTE: Please, check only 1 box! (with an `x`)
|
||||||
|
If your PR requires multiple boxes to be checked, you'll most likely need to
|
||||||
|
split it into multiple PRs. This makes things easier and faster to code review.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- [ ] Dependency upgrade
|
||||||
|
- [ ] Bugfix (non-breaking change which fixes an issue)
|
||||||
|
- [ ] New service (thank you!)
|
||||||
|
- [ ] New feature (which adds functionality to an existing service)
|
||||||
|
- [ ] Breaking change (fix/feature causing existing functionality to break)
|
||||||
|
- [ ] Code quality improvements to existing code or addition of tests
|
||||||
|
|
||||||
|
## Example of code:
|
||||||
|
<!--
|
||||||
|
Supplying a code snippet, makes it easier for a maintainer to test your PR.
|
||||||
|
Furthermore, for new services, it gives an impression of how we should use it.
|
||||||
|
Note: Remove this section for a dependency upgrade, a bugfix or code quality/test PR.
|
||||||
|
-->
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Additional information
|
||||||
|
<!--
|
||||||
|
Details are important, and help maintainers processing your PR.
|
||||||
|
Please be sure to fill out additional details, if applicable.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- This PR fixes or closes issue: fixes #
|
||||||
|
- This PR is related to issue:
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
<!--
|
||||||
|
Put an `x` in the boxes that apply. You can also fill these out after
|
||||||
|
creating the PR. If you're unsure about any of them, don't hesitate to ask.
|
||||||
|
We're here to help! This is simply a reminder of what we are going to look
|
||||||
|
for before merging your code.
|
||||||
|
-->
|
||||||
|
|
||||||
|
- [ ] The code change is tested and works locally.
|
||||||
|
- [ ] Local tests pass. **Your PR cannot be merged unless tests pass**
|
||||||
|
- [ ] There is no commented out code in this PR.
|
||||||
|
- [ ] Tests have been added to verify that the new code works.
|
||||||
|
|
||||||
|
If user exposed functionality or configuration variables are added/changed:
|
||||||
|
|
||||||
|
- [ ] Documentation added/updated to README
|
Loading…
Reference in a new issue