Project: ORY Hydra (Provisioning / Key Management)
File: CONTRIBUTING.md

<!-- AUTO-GENERATED, DO NOT EDIT! --> <!-- Please edit the original at https://github.com/ory/meta/blob/master/templates/repository/common/CONTRIBUTING.md --> <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> - <!-- END doctoc generated TOC please keep comment here to allow auto update --> 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 disclose it by contacting us at security@ory.sh. There are many ways in which you can contribute. The goal of this document is to provide a high-level overview of how you can get involved in Ory. As a potential contributor, your changes and ideas are welcome at any hour of the day or night, on weekdays, weekends, and holidays. Please do not ever hesitate to ask a question or send a pull request. If you are unsure, 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 with Ory Hydra's direction. A great way to do this is via or the . I am new to the community. Where can I find the I have a question. Where can I get I would like to contribute but I am not sure how. Are there I want to talk to other Ory Hydra users. I would like to know what I am agreeing to when I contribute to Ory Hydra. Does Ory have I would like updates about new versions of Ory Hydra. If you want to start to contribute code right away, take a look at the . There are many other ways you can contribute. Here are a few things you can do to help out: Give us a star. It may not seem like much, but it really makes a difference. This is something that everyone can do to help out Ory Hydra. Github stars help the project gain visibility and stand out. Join the community. Sometimes helping people can be as easy as listening to their problems and offering a different perspective. Join our Slack, have a look at discussions in the forum and take part in community events. More info on this in . Answer discussions. At all times, there are several unanswered discussions on GitHub. You can see an

If you think you know an answer or can provide some information that might help, please share it! Bonus: You get GitHub achievements for answered discussions. Help with open issues. We have a lot of open issues for Ory Hydra and some of them may lack necessary information, some are duplicates of older issues. You can help out by guiding people through the process of filling out the issue template, asking for clarifying information or pointing them to existing issues that match their description of the problem. Review documentation changes. Most documentation just needs a review for proper spelling and grammar. If you think a document can be improved in any way, feel free to hit the `edit` button at the top of the page. More info on contributing to the documentation . Help with tests. Pull requests may lack proper tests or test plans. These are needed for the change to be implemented safely. We use . You are welcome to drop in and ask questions, discuss bugs and feature requests, talk to other users of Ory, etc. Check out . This is a great place for in-depth discussions and lots of code examples, logs and similar data. You can also join our community calls if you want to speak to the Ory team directly or ask some questions. You can find more info and participate in in the #community-call channel. If you want to receive regular notifications about updates to Ory Hydra, consider joining the mailing list. We will only send you vital information on the projects that you are interested in. Also, . One of the most impactful ways to contribute is by adding examples. You can find an overview of examples using Ory services on the . Source code for examples can be found in most cases in the repository. If you would like to contribute a new example, we would love to hear from you! Please to describe your example before you start working on it. We would love to provide guidance to make for a pleasant contribution experience. Go through this checklist to contribute an example: Create a GitHub issue proposing a new example and make sure it's different from an existing one. Fork the repo and create a feature branch off of `master` so that changes do not get mixed up. Add a descriptive prefix to commits. This ensures a uniform commit history and helps structure the changelog. Please refer to this for an overview. Create a `README.md` that explains how to use the example. (Use ). Open a pull request and maintainers will review and merge your example. Unless you are fixing a known bug, we strongly recommend discussing it with the core team via a GitHub issue or before getting started to ensure your work is consistent with Ory Hydra's roadmap and

All contributions are made via pull requests. To make a pull request, you will need a GitHub account; if you are unclear on this process, see GitHub's documentation on and . Pull requests should be targeted at the `master` branch. Before creating a pull request, go through this checklist: Create a feature branch off of `master` so that changes do not get mixed up. your local changes against the `master` branch. Run the full project test suite with the `go test -tags sqlite ./...` (or equivalent) command and confirm that it passes. Run `make format` Add a descriptive prefix to commits. This ensures a uniform commit history and helps structure the changelog. Please refer to this for an overview. If a pull request is not ready to be reviewed yet . Before your contributions can be reviewed you need to sign our . This agreement defines the terms under which your code is contributed to Ory. More specifically it declares that you have the right to, and actually do, grant us the rights to use your contribution. You can see the Apache 2.0 license under which our projects are published . When pull requests fail the automated testing stages (for example unit or E2E tests), authors are expected to update their pull requests to address the failures until the tests pass. Pull requests eligible for review follow the repository's code formatting conventions; include tests that prove that the change works as intended and does not add regressions; document the changes in the code and/or the project's documentation; pass the CI pipeline; have signed our ; include a proper git commit message following the . If all of these items are checked, the pull request is ready to be reviewed and you should change the status to "Ready for review" and . Reviewers will approve the pull request once they are satisfied with the patch. Please provide documentation when changing, removing, or adding features. All Ory Documentation resides in the . For further instructions please head over to the Ory Documentation . Please disclose vulnerabilities exclusively to . Do not use GitHub issues. Please run `make format` to format all source code following the Ory standard. ```bash git clone git@github.com:ory/ory/hydra.git git remote add fork git@github.com:<YOUR-GITHUB-USERNAME-HERE>/ory/hydra.git git fetch origin git checkout master git pull --rebase git checkout my-feature-branch git add -A git commit -a -m "fix: this is the subject line" -m "This is the body line. Closes #123" git push -u fork my-feature-branch ``` Now go to the project's GitHub Pull Request page and click "New pull request" 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 welcome discussion about creating a welcoming, safe, and productive environment for the community. If you have any questions, feedback, or concerns .