The easiest ways to contribute is to open an issue and start a discussion. Then we can decided if and how a feature or a change could be implemented and if you should submit a pull requests with code changes.
We monitor the identityserver3 tag on StackOverflow.
Please start a discussion on the core repo issue tracker.
Please log a new issue in the appropriate GitHub repo:
- Core
- WS-Federation plugin
- EntityFramework support
- ASP. NET Identity support
- MembershipReboot support
- AccessToken validation
- Samples
Due to the security nature of IdentityServer, errors are very vague. Make sure you read and understand how to enable logging before opening an issue/bug report.
https://gitter.im/IdentityServer/IdentityServer3
The best way to get your bug fixed is to be as detailed as you can be about the problem. Providing a minimal project with steps to reproduce the problem is ideal. Here are questions you can answer before you file a bug to make sure you're not missing any important information.
- Did you read the documentation?
- Did you include the snippet of broken code in the issue?
- What are the EXACT steps to reproduce this problem?
GitHub supports markdown, so when filing bugs make sure you check the formatting before clicking submit.
You will need to sign a Contributor License Agreement before submitting your pull request.
Make sure you can build the code. Familiarize yourself with the project workflow and our coding conventions. If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests.
We only accept PRs to the dev branch.
Before submitting a feature or substantial code contribution please discuss it with the team and ensure it follows the product roadmap. Here's a list of blog posts that are worth reading before doing a pull request:
- Open Source Contribution Etiquette by Miguel de Icaza
- Don't "Push" Your Pull Requests by Ilya Grigorik.
- 10 tips for better Pull Requests by Mark Seemann
- How to write the perfect pull request by GitHub
Here's a few things you should always do when making changes to the code base:
Commit/Pull Request Format
Summary of the changes (Less than 80 chars)
- Detail 1
- Detail 2
#bugnumber (in this specific format)
Tests
- Tests need to be provided for every bug/feature that is completed.
- Tests only need to be present for issues that need to be verified by QA (e.g. not tasks)
- If there is a scenario that is far too hard to test there does not need to be a test for it.
- "Too hard" is determined by the team as a whole.
Contribution Packages
If you are planning to add functionality via contribution packages, we would like you to use IdentityServer3.Contrib.* as a naming convention.