Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JCF: based on this morning's CT meeting, mention testing requirements… #396

Merged
merged 1 commit into from
Oct 21, 2024
Merged

JCF: based on this morning's CT meeting, mention testing requirements… #396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/development_workflow_gitflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ A team is defined at the level of [the GitHub DUNE-DAQ organization](https://git
We have four types of branch in our workflow:

* **Common branches**
* The default branch of each repository. As of Sep-23-2024, the default branch for all repositories is `develop`. This branch exists permanently and, shared among all developers, is not generally meant to be worked on (i.e., committed to) directly; it can only be updated via Pull Requests (PRs). While we do not require reviews before pushing to `develop`, developers are strongly encouraged to seek a review for any non-trivial change. An example of a trivial change would be fixing a typo in the README or bumping a version number.
* The default branch of each repository. As of Sep-23-2024, the default branch for all repositories is `develop`. This branch exists permanently and, shared among all developers, is not generally meant to be worked on (i.e., committed to) directly; it can only be updated via Pull Requests (PRs). While we do not require reviews before pushing to `develop`, developers are strongly encouraged to seek a review for any non-trivial change. An example of a trivial change would be fixing a typo in the README or bumping a version number. At a minimum it should be established that no changes to the `develop` branch should cause unit test failures (`dbt-build --unittest <repo name>`) or fail the simplest integration test (`pytest -v -s $DAQSYSTEMTEST_SHARE/integtest/minimal_system_quick_test.py`).
* **Feature branches**
* Forked off of the `develop` branch, and where developers are meant to do their work for a specific task. When work on this branch is complete, it is merged into the `develop` branch via a PR.
* **Release preparation branches**
* These are only intended for use if changes need to be made after the initial tags are made for a particular frozen release's release cycle
* Intended to be forked off the tag, _not_ `develop`
* Can only be updated via PRs _with at least one approval review_ before release cut-off time
* Can only be updated via PRs _with at least one approval review_ before release cut-off time; again, unit tests and `minimal_system_quick_test.py` should continue to pass.
* After the final tag for the frozen release is made, notify the Software Coordination team to merge it into `develop`, along with any special instructions (like if there shouldn't, in fact, be a merge, or if only a subset of the commits on the branch should be merged)
* Nomenclature: for a given release `fddaq-vX.Y.Z` use `prep-release/fddaq-vX.Y.Z` and similarly `prep-release/nddaq-vX.Y.Z` for `nddaq-vX.Y.Z`
* **Patch branches** `patch/fddaq-vX.Y.x`/`patch/nddaq-vX.Y.x`**
Expand Down