Skip to content

Development workflow for contributions

Jump to bottom
Cole Monnahan edited this page Dec 17, 2020 · 1 revision

Contributions from users are encouraged, including simple documentation fixes, enhancement ideas, or more substantive code contributions.

Generally, the master branch is the latest stable release. The development branch contains stable, tested updates (passing local tests and integrated tests in the future as TravisCI is no longer working). Branches are used to develop and test updates before merging them into the development branch.

Please use the following (draft) workflow if you wish to contribute. Please also refer to this page which has more guidance for productive contributions.

  1. Fork the VAST repo and create a branch off of the development branch relevant to your change.
  2. Make sure you can run and pass the automated tests.
  3. Make changes, consistently merging in commits from the upstream development branch to keep it up-to-date.
  4. Before doing a pull request, rerun the automated tests and verify they still pass.
  5. Push your local branch to your forked repo, then do a pull request to the development branch of VAST. Follow standard good practices for this.
  6. Once reviewed it will be merged into development.

Started December 2020 by Cole and subject to change. Feedback welcome.

Example applications:

  1. Index standardization
  2. Empirical Orthogonal Functions
  3. Ordination using joint species distribution model
  4. End-of-century projections
  5. Expand length and age-composition samples
  6. Combine condition and biomass data
  7. Expand stomach content samples
  8. Combine presence/absence, counts, and biomass data
  9. Seasonal and annual variation
  10. Combine acoustic and bottom trawl data
  11. Surplus production models
  12. Multispecies model of biological interactions
  13. Stream network models

Usage demos:

Project structure and utilities:

Clone this wiki locally