Skip to content

Commit

Permalink
docs: Updates issue and pull request templates (#7)
Browse files Browse the repository at this point in the history
Signed-off-by: aeneasr <[email protected]>
  • Loading branch information
aeneasr authored May 23, 2019
1 parent ab6f24a commit a1220ba
Show file tree
Hide file tree
Showing 7 changed files with 309 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**

A clear and concise description of what the bug is.

**Reproducing the bug**

Steps to reproduce the behavior:

<!--
1. Run `docker run ....`
2. Make API Request to with `curl ...`
3. Request fails with response: `{"some": "error"}`
-->

*Server logs*

<!--
```
log=error ....
```
-->

*Server configuration*

<!--
PLEASE OMIT SENSITIVE VALUES
```yaml
server:
admin:
port: 1234
```
-->

**Expected behavior**

A clear and concise description of what you expected to happen.

**Environment**

* Version: v1.2.3, git sha hash
* Environment: Debian, Docker, ...

**Additional context**

Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +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 [...]

**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.

10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Disclose (potential) security vulnerability
about: Disclose security vulnerabilities to [email protected]
---

Please refrain from publishing (potential) security vulnerabilities publicly
on the forums, the chat, or GitHub.

We describe how to disclose (potential) security vulnerabilities in our
[Security Policy](SECURITY.md)
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/support.md
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).
40 changes: 40 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## 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
chance substantial changes will be requested or that the changes will be rejected.
You can discuss changes with maintainers either in the [ORY Community Forums](https://community.ory.sh/) or
join the [ORY Chat](https://www.ory.sh/chat).
-->

## 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 read the [security policy](SECURITY.md)
- [ ] 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 necessary documentation within the code base (if appropriate)
- [ ] I have documented my changes in the [developer guide](https:/ory/docs) (if appropriate)

## 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...
-->
84 changes: 84 additions & 0 deletions .releaser/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
ORY Hydra
Copyright (c) 2019 ORY GmbH

*** END USER LICENSE AGREEMENT ***

IMPORTANT: PLEASE READ THIS LICENSE CAREFULLY BEFORE USING THIS SOFTWARE.

1. LICENSE

By receiving, opening the file package, and/or using ORY Hydra ("Software") containing this software, you agree that
this End User User License Agreement(EULA) is a legally binding and valid contract and agree to be bound by it.
You agree to abide by the intellectual property laws and all of the terms and conditions of this Agreement.

Unless you have a different license agreement signed by ORY GmbH your use of ORY Hydra indicates
your acceptance of this license agreement and warranty.

Subject to the terms of this Agreement, ORY GmbH grants to you a limited, non-exclusive, non-transferable
license, without right to sub-license, to use ORY Hydra in accordance with this Agreement and any other written
agreement with ORY GmbH. ORY GmbH does not transfer the title of ORY Hydra to you; the license granted to you is not a
sale. This agreement is a binding legal agreement between ORY GmbH and the purchasers or users of ORY Hydra.

If you do not agree to be bound by this agreement, remove ORY Hydra from your computer now and, if applicable,
promptly return to ORY GmbH by mail any copies of ORY Hydra and related documentation and packaging in your possession.

2. DISTRIBUTION

ORY Hydra and the license herein granted shall not be copied, shared, distributed, re-sold, offered for re-sale,
transferred or sub-licensed in whole or in part except that you may make one copy for archive purposes only. For
information about redistribution of ORY Hydra contact ORY GmbH.

3. USER AGREEMENT

3.1 Use

Your license to use ORY Hydra is limited to the number of licenses purchased by you. You shall not allow others to use,
copy or evaluate copies of ORY Hydra.

3.2 Use Restrictions

You shall use ORY Hydra in compliance with all applicable laws and not for any unlawful purpose. Without limiting the
foregoing, use, display or distribution of ORY Hydra together with material that is pornographic, racist, vulgar,
obscene, defamatory, libelous, abusive, promoting hatred, discriminating or displaying prejudice based on religion,
ethnic heritage, race, sexual orientation or age is strictly prohibited.

Each licensed copy of ORY Hydra may be used on one single computer location by one user. Use of ORY Hydra means that you have loaded, installed, or run ORY Hydra on a computer or similar device. If you install ORY Hydra onto a multi-user platform, server or network, each and every individual user of ORY Hydra must be licensed separately.

You may make one copy of ORY Hydra for backup purposes, providing you only have one copy installed on one computer being used by one person. Other users may not use your copy of ORY Hydra . The assignment, sublicense, networking, sale, or distribution of copies of ORY Hydra are strictly forbidden without the prior written consent of ORY GmbH. It is a violation of this agreement to assign, sell, share, loan, rent, lease, borrow, network or transfer the use of ORY Hydra. If any person other than yourself uses ORY Hydra registered in your name, regardless of whether it is at the same time or different times, then this agreement is being violated and you are responsible for that violation!

3.3 Copyright Restriction

This Software contains copyrighted material, trade secrets and other proprietary material. You shall not, and shall not attempt to, modify, reverse engineer, disassemble or decompile ORY Hydra. Nor can you create any derivative works or other works that are based upon or derived from ORY Hydra in whole or in part.

ORY GmbH's name, logo and graphics file that represents ORY Hydra shall not be used in any way to promote products developed with ORY Hydra . ORY GmbH retains sole and exclusive ownership of all right, title and interest in and to ORY Hydra and all Intellectual Property rights relating thereto.

Copyright law and international copyright treaty provisions protect all parts of ORY Hydra, products and services. No program, code, part, image, audio sample, or text may be copied or used in any way by the user except as intended within the bounds of the single user program. All rights not expressly granted hereunder are reserved for ORY GmbH.

3.4 Limitation of Responsibility

You will indemnify, hold harmless, and defend ORY GmbH , its employees, agents and distributors against any and all claims, proceedings, demand and costs resulting from or in any way connected with your use of ORY GmbH's Software.

In no event (including, without limitation, in the event of negligence) will ORY GmbH , its employees, agents or distributors be liable for any consequential, incidental, indirect, special or punitive damages whatsoever (including, without limitation, damages for loss of profits, loss of use, business interruption, loss of information or data, or pecuniary loss), in connection with or arising out of or related to this Agreement, ORY Hydra or the use or inability to use ORY Hydra or the furnishing, performance or use of any other matters hereunder whether based upon contract, tort or any other theory including negligence.

ORY GmbH's entire liability, without exception, is limited to the customers' reimbursement of the purchase price of the Software (maximum being the lesser of the amount paid by you and the suggested retail price as listed by ORY GmbH ) in exchange for the return of the product, all copies, registration papers and manuals, and all materials that constitute a transfer of license from the customer back to ORY GmbH.

3.5 Warranties

Except as expressly stated in writing, ORY GmbH makes no representation or warranties in respect of this Software and expressly excludes all other warranties, expressed or implied, oral or written, including, without limitation, any implied warranties of merchantable quality or fitness for a particular purpose.

3.6 Governing Law

This Agreement shall be governed by the law of the Germany applicable therein. You hereby irrevocably attorn and submit to the non-exclusive jurisdiction of the courts of Germany therefrom. If any provision shall be considered unlawful, void or otherwise unenforceable, then that provision shall be deemed severable from this License and not affect the validity and enforceability of any other provisions.

3.7 Termination

Any failure to comply with the terms and conditions of this Agreement will result in automatic and immediate termination of this license. Upon termination of this license granted herein for any reason, you agree to immediately cease use of ORY Hydra and destroy all copies of ORY Hydra supplied under this Agreement. The financial obligations incurred by you shall survive the expiration or termination of this license.

4. DISCLAIMER OF WARRANTY

THIS SOFTWARE AND THE ACCOMPANYING FILES ARE SOLD "AS IS" AND WITHOUT WARRANTIES AS TO PERFORMANCE OR MERCHANTABILITY OR ANY OTHER WARRANTIES WHETHER EXPRESSED OR IMPLIED. THIS DISCLAIMER CONCERNS ALL FILES GENERATED AND EDITED BY ORY Hydra AS WELL.

5. CONSENT OF USE OF DATA

You agree that ORY GmbH may collect and use information gathered in any manner as part of the product support services provided to you, if any, related to ORY Hydra.ORY GmbH may also use this information to provide notices to you which may be of use or interest to you.

93 changes: 93 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Contributing to ORY Hydra

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Introduction](#introduction)
- [Contributing Code](#contributing-code)
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
- [Code Style](#code-style)
- [Pull request procedure](#pull-request-procedure)
- [Communication](#communication)
- [Conduct](#conduct)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Introduction

Please note: We take ORY Hydra's security and our users' trust very seriously. If you believe you have found a
security issue in ORY Hydra, please responsibly disclose by contacting us at [email protected].

First: if you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. You won't be
yelled at for giving it your best effort. The worst that can happen is that you'll be politely asked to change
something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.

That said, if you want to ensure that a pull request is likely to be merged, talk to us! You can find out our thoughts
and ensure that your contribution won't clash or be obviated by ORY Hydra's normal direction. A great way to do this is via
the [ORY Community](https://community.ory.sh/) or join the [ORY Chat](https://www.ory.sh/chat).

## Contributing Code

Unless you are fixing a known bug, we **strongly** recommend discussing it with the core team via a GitHub issue or
[in our chat](https://www.ory.sh/chat) before getting started to ensure your work is consistent with
ORY Hydra's roadmap and architecture.

All contributions are made via pull request. Note that **all patches from all contributors get reviewed**. After a pull
request is made other contributors will offer feedback, and if the patch passes review a maintainer will accept it with
a comment. When pull requests fail testing, authors are expected to update their pull requests to address the failures
until the tests pass and the pull request merges successfully.

At least one review from a maintainer is required for all patches (even patches from maintainers).

Reviewers should leave a "LGTM" comment once they are satisfied with the patch. If the patch was submitted by a
maintainer with write access, the pull request 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.

## Code Style

Please follow these guidelines when formatting source code:

* Go code should match the output of `gofmt -s`

## Pull request procedure

To make a pull request, you will need a GitHub account; if you are unclear on this process, see GitHub's
documentation on [forking](https://help.github.com/articles/fork-a-repo) and [pull requests](https://help.github.com/articles/using-pull-requests).
Pull requests should be targeted at the `master` branch. Before creating a pull request, go through this checklist:

1. Create a feature branch off of `master` so that changes do not get mixed up.
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `master` branch.
1. Run the full project test suite with the `go test ./...` (or equivalent) command and confirm that it passes.
1. Run `gofmt -s` (if the project is written in Go).
1. Ensure that each commit has a subsystem prefix (ex: `controller: `).

Pull requests will be treated as "review requests," and maintainers will give feedback on the style and substance of the patch.

Normally, all pull requests must include tests that test your change. Occasionally, a change will
be very difficult to test for. In those cases, 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 questions, discuss bugs, etc.

## Conduct

Whether you are a regular contributor or a newcomer, we care about making this community a safe place for you and
we've got your back.

* We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender,
sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
* Please avoid using nicknames that might detract from a friendly, safe and welcoming environment for all.
* Be kind and courteous. There is no need to be mean or rude.
* We will exclude you from interaction if you insult, demean or harass anyone. In particular, we do not tolerate
behavior that excludes people in socially marginalized groups.
* Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or
made uncomfortable by a community member, please contact one of the channel ops or a member of the ORY
Hydra core team immediately.
* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.

We welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, feedback, or concerns [please let us know](https://www.ory.sh/chat).

0 comments on commit a1220ba

Please sign in to comment.