-
-
Notifications
You must be signed in to change notification settings - Fork 347
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Updates issue and pull request templates (#52)
Signed-off-by: aeneasr <[email protected]>
- Loading branch information
Showing
6 changed files
with
109 additions
and
13 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,28 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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,17 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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,8 @@ | ||
--- | ||
name: Disclose vulnerability | ||
about: Please do not open a public issue about the vulnerability but instead disclose it directly to [email protected] | ||
|
||
--- | ||
|
||
Please refrain from publishing (potential) security vulnerabilities publicly on the forums, the chat, or GitHub. Instead, | ||
send us an email to [[email protected]](mailto:[email protected]) and we will respond within 24 hours. |
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,8 @@ | ||
--- | ||
name: Support request | ||
about: Please use our forums (community.ory.sh) or the chat (ory.sh/chat) to ask for support. | ||
|
||
--- | ||
|
||
Please use issues only to file potential bugs or request features. For everything else please go to | ||
the [ORY Community](https://community.ory.sh/) or join the [ORY Chat](https://www.ory.sh/chat). |
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 |
---|---|---|
@@ -1,11 +1,51 @@ | ||
Before creating your pull request, make sure that you have | ||
[signed the DOC](https://github.com/ory/keto/blob/master/CONTRIBUTING.md#developers-certificate-of-origin). You can ammend your | ||
signature to the current commit using `git commit --amend -s`. | ||
<!-- | ||
Before submitting this pull request, please | ||
Please create PRs only for bugs, or features that have been discussed with the maintainers, either at the | ||
[ORY Community](https://community.ory.sh/) or join the [ORY Chat](https://www.ory.sh/chat). | ||
1. discuss the changes with maintainers either at the | ||
[ORY Community](https://community.ory.sh/) or join the [ORY Chat](https://www.ory.sh/chat). Depending on the scope | ||
and size of your change, we might want to discuss how the issue should be addressed. You may submit your pull request | ||
regardless, but review time might be longer with more requested changes form maintainers. | ||
2. make sure to sign our [Developer's Certificate of Origin](https://github.com/ory/keto/blob/master/CONTRIBUTING.md#developers-certificate-of-origin) | ||
by signing your commit(s). You can amend your signature to the most recent commit by using `git commit --amend -s`. If you | ||
amend the commit, you might need to force push using `git push --force HEAD:<branch>`. Please be very careful when using | ||
force push. | ||
3. If this PR addresses an undocumented security issue, please refrain from proposing the change now and notify us about | ||
this issue by sending an email to [[email protected]](mailto:[email protected]) instead. We will respond within 24 hours. | ||
If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHub | ||
and send us an email to [[email protected]](mailto:[email protected]) instead. | ||
Please remove this text once you completed these steps. | ||
--> | ||
|
||
Please remove this template if you completed the steps from above. | ||
## Related issue | ||
|
||
<!-- | ||
Please link the GitHub issue this pull request resolves in the format of `#1234`. If you discussed this change | ||
with a maintainer, please mention her/him using the `@` syntax (e.g. `@aeneasr`). | ||
If this change neither resolves an existing issue nor has sign-off from one of the maintainers, there is a non-zero | ||
chance substantial changes will be requested or that the changes will be rejected. | ||
--> | ||
|
||
## Proposed changes | ||
|
||
<!-- | ||
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. | ||
--> | ||
|
||
## 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._ | ||
--> | ||
|
||
- [ ] I have read the [contributing guidelines](CONTRIBUTING.md) | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] I have added necessary documentation within the code base (if appropriate) | ||
- [ ] I have documented my changes in the [developer guide](https://github.com/ory/docs) (if appropriate, applies only to ORY Hydra, ORY Keto, ORY Oathkeeper). | ||
|
||
## Further comments | ||
|
||
<!-- | ||
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution | ||
you did and what alternatives you considered, etc... | ||
--> |