Skip to end of metadata
Go to start of metadata

After you've done the development work to fix a bug or remove a feature, you may want to contribute that code back to the Ed-Fi Core. (See the Code Submissions from Ed-Fi Licensees page for an overview of the development process.) This guide assumes you have already committed and pushed your changes to a Git repository.

Once all changes are committed, you may contribute the changes back to the Ed-Fi Alliance for inclusion in core using a pull request. The Alliance hosts the following repositories:

Make sure there is an issue in the Ed-Fi Alliance Tracker system for the code you want to submit. If there isn't one, you'll need to create one. See the Code Contribution Guidelines for more details.


Step-by-Step Guide

This section provides a walkthrough of submitting a pull request to the Alliance.

  1. Push your changes to your forked repository using the following command. In this example, the changes were made in Ed-Fi-Dashboard.

    cd Ed-Fi-Dashboard
    git push origin feature-DASH-89
  2. Open your browser and navigate to the
  3. Click on the "Repostories" tab.
  4. Click on the repository that contains your change.
  5. Switch the "branch" dropdown to your development branch (e.g., feature-JIRAIssue-89).
  6. Click New pull request.
  7. Click the "Edit" button at the top of the pull request screen.
  8. Make sure the "Base Fork" is "Ed-Fi-Alliance\Ed-Fi-Dashboard" (or appropiate repository) and "base" is set to the development branch.
  9. GitHub should calculate the pull request at this point and you should see a green message saying it is ready to be automatically merged. 

    If you do not see this, then your forked code is out of date with the Ed-Fi Alliance code base. In this case, you must first pull the latest code and handle any merge conflicts prior to submitting a pull request.

  10. Edit the commit message to include the JIRA issue being addressed by the pull request. See Code Contribution Guidelines.
  11. Submit the pull request.