- Make sure that there is a corresponding issue for your change first. If there is none, create one.
- Create a fork in GitHub
- Create a branch off the
master
branch. Name it something that that makes sense, such asissue-123
orgithubhandle-issue
. This makes it easy for everyone to figure out what the branch is used for. It also makes it easier to isolate your change from incoming changes from the origin. - Commit your changes and push your changes to GitHub.
- Create a pull request against the origin's
master
branch. See How to: Submit a Pull Request.
DOs and DON'Ts
- DO follow our coding style (see below)
- DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
- DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.
- DON'T surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
Issues
If an issue is complex, consider filing it and giving us time to respond before sending a corresponding Pull Request. If you want to work on the issue, just let it be known on the issue thread. Giving us a chance to review the issue will help save time. For example, we might let you know why existing behavior can't be changed or about particular implementation constraints you need to keep in mind, etc.
Don't feel obliged to match every issue with a Pull Request. Simply filing issues for problems you encounter is a great way to contribute too!
We use JIRA to keep track of issues, see Ed-Fi Issue Tracker. Keep in mind that some tech components require a license, for access level check out our Technical Community Guidelines.
Licensing
- DO NOT submit Pull Requests that alter licensing related files or headers. If you believe there's a problem with them, file an issue and let us take care of it.
We borrowed these awesome guidelines from the .NET CoreFX team https://github.com/dotnet/corefx/wiki/Contributing