Skip to content

Development Workflow

remonds edited this page Apr 11, 2025 · 3 revisions

Branching strategy

We follow a three-level branching strategy:

  1. main branch: Contains stable, production-ready code. Each release is tagged here using semantic versioning.
  2. dev branch: Where the active development of the next version happens.
  3. feature/* branches: Created for individual features or tasks. Once a feature is complete, it is merged back into dev.

Workflow Steps

  1. Start a New Feature

    • Create a feature branch from dev.
    • Naming convention: feature/<short-description>
    • Example: feature/lognormal-true-model
  2. Development

    • Work on the feature in the feature branch.
    • Regular commits help to track progress and keep the work isolated from the main development.
  3. Testing

    • Test the feature thoroughly in the feature branch before merging.
    • When the feature is complete and passes all tests, proceed to the next step.
  4. Merge to dev

    • Once the feature is complete, reviewed, and tested, it should be merged into the dev branch.
    • Ensure that the merge is done after resolving any conflicts and that the integration is smooth.
  5. Release Preparation

    • When development in dev is complete and the new version is ready, merge dev into main.
    • Tag the release with an appropriate version number, following semantic versioning (e.g., v1.0.0-additive-on-obs).
  6. Tag a Release

    • After merging dev to main, tag the release to mark it as a stable version.
    • The release tag is used for versioning purposes and to make the code accessible for production.
  7. Publish the Release

    • Publish the release on GitHub, and update relevant documentation (e.g., in the README.md).

Best Practices

  • Regularly sync your feature branches with dev to minimize merge conflicts.
  • Commit often with meaningful commit messages.
  • Perform code reviews before merging a feature into dev.
  • Ensure the dev branch is stable and tested before tagging a release.

See our README for versioning and release information.

Home

  1. Development workflow
  2. Measurement uncertainty models
    1. Additive uncertainty on observed values
    2. Lognormal uncertainty on true values

Clone this wiki locally