Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Make sure that there is a corresponding issue for your change first. If there is none, create one.
  2. Create a fork in GitHub
  3. Create a branch off the master branch. Name it something that that makes sense, such as issue-123 or githubhandle-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.
  4. Commit your changes and push your changes to GitHub. 
  5. Create a pull request against the origin's master branch. See how-to submit bug fixes/enhancementsHow 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.

...

Tip

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 feature matrix 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.

...