-
Notifications
You must be signed in to change notification settings - Fork 360
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update github templates (#409)
Signed-off-by: aeneasr <[email protected]>
- Loading branch information
Showing
7 changed files
with
49 additions
and
35 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
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,22 +1,22 @@ | ||
--- | ||
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 [...] | ||
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. | ||
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 |
---|---|---|
@@ -1,8 +1,10 @@ | ||
--- | ||
name: Support request | ||
about: Please use our forums (community.ory.sh) or the chat (ory.sh/chat) to ask for support | ||
|
||
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). | ||
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 |
---|---|---|
|
@@ -26,9 +26,13 @@ them, don't hesitate to ask. We're here to help! This is simply a reminder of wh | |
|
||
- [ ] I have read the [contributing guidelines](../blob/master/CONTRIBUTING.md). | ||
- [ ] I have read the [security policy](../security/policy). | ||
- [ ] I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security. | ||
vulnerability, I confirm that I got green light (please contact [[email protected]](mailto:[email protected])) from the maintainers to push the changes. | ||
- [ ] I have added tests that prove my fix is effective or that my feature works. | ||
- [ ] I confirm that this pull request does not address a security | ||
vulnerability. If this pull request addresses a security. vulnerability, I | ||
confirm that I got green light (please contact | ||
[[email protected]](mailto:[email protected])) from the maintainers to push | ||
the changes. | ||
- [ ] I have added tests that prove my fix is effective or that my feature | ||
works. | ||
- [ ] I have added or changed [the documentation](docs/docs). | ||
|
||
## Further comments | ||
|
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 |
---|---|---|
|
@@ -56,22 +56,24 @@ should be merged by the submitter after review. | |
|
||
## Disclosing vulnerabilities | ||
|
||
Please disclose vulnerabilities exclusively to [[email protected]](mailto:[email protected]). Do | ||
not use GitHub issues. | ||
Please disclose vulnerabilities exclusively to | ||
[[email protected]](mailto:[email protected]). Do not use GitHub issues. | ||
|
||
## Code Style | ||
|
||
Please follow these guidelines when formatting source code: | ||
|
||
- Go code should match the output of `gofmt -s` and pass `golangci-lint run`. | ||
- NodeJS and JavaScript code should be prettified using `npm run format` where appropriate. | ||
- NodeJS and JavaScript code should be prettified using `npm run format` where | ||
appropriate. | ||
|
||
## Documentation | ||
|
||
Please provide documentation when changing, removing, or adding features. Documentation | ||
resides in the project's [docs](docs) folder. Some documents are generated using `npm run gen`. | ||
Please provide documentation when changing, removing, or adding features. | ||
Documentation resides in the project's [docs](docs) folder. Generate API and | ||
configuration reference documentation using `cd docs; npm run gen`. | ||
|
||
More information on the docs pipeline can be found in [docs/README.md](docs/README.md). | ||
For further instructions please head over to [docs/README.md](docs/README.md). | ||
|
||
## Pull request procedure | ||
|
||
|
@@ -99,7 +101,7 @@ please include a note in your commit message explaining why. | |
|
||
## Communication | ||
|
||
We use [discord](https://www.ory.sh/chat). You are welcome to drop in and ask | ||
We use [Slack](https://www.ory.sh/chat). You are welcome to drop in and ask | ||
questions, discuss bugs, etc. | ||
|
||
## Conduct | ||
|
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
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