Skip to content

Development Coordination Process

C Custodio edited this page Jan 29, 2015 · 17 revisions

This is a proposed workflow for fixing issues and adding features to SEED.

  1. Use Github Issue Tracker to report the bug or request a new feature. Include as much detail as possible and screencaps, if it helps.

  2. QA Lead assigns issues to Developers.

  3. Make a branch off of the "master" from the main code base or fork the SEED code to a new repository.
    Difference betwen branches and forks

  4. Make a branch in individual dev environment with a descriptive name.

  5. Change code and push changes to branch.

  6. Test on individual development environment.

  7. For large or long-running changes, periodically merge master down to branch and re-test.

  8. Issue pull request to SEED repository.

  9. Repository manager merges the developer branches into a "testing " branch and pushes the code into the testing environment (seedtest.lbl.gov).

  10. Start review process to accept the branch into the main code.

  11. Develop acceptance tests.

  12. Unit tests (included in code) if possible (some issues will be easier to do than others).

  13. UI testing

    • Manual testing, walk through the GUI
    • Selenium (screen capture feature) - Firefox only -
    • Jasmine
  14. Visual code review

    • Minimum of one person, can bring in another person if needed
  15. Make sure changes are well documented.

    • In code
    • PyDocs for Readthedocs
  16. Comments on pull request.

  17. Accept pull-request. Merge code into "master" branch in seed repository.

  18. Push the updated "master" branch to the production environment (seed.lbl.gov).

  19. Repository manager closes the pull-request.

  20. Test the updated code in the production server.

  21. QA Lead closes the issue thread.


Pull-requests are confirmed by the repository owner and should be tested first in the developer version of SEED before being merged with the official public version.
https://guides.github.com/activities/forking/#making-a-pull-request