There are many ways to contribute to OpenLIFU.
- Submit a feature request or bug, or add to the discussion on the OpenLIFU issue tracker
- Submit a Pull Request to improve OpenLIFU.
- Every commit should reference the issue number with which it is associated
- (with exceptions when software requirements traceability is guaranteed, such as for version bumps of software that is itself traceable)
- Commits should be reasonably granular and semantically atomic.
- Pull requests should not be squashed upon merging.
If you are new to OpenLIFU development and you don't have push access to the OpenLIFU repository, here are the steps:
- Fork and clone the repository.
- Create a branch.
- Push the branch to your GitHub fork.
- Create a Pull Request.
This corresponds to the Fork & Pull Model described in the GitHub documentation
guides.
If you have push access to this repository, you could simply push your branch
and create a Pull Request. This corresponds to the Shared Repository Model
and will facilitate other developers to checkout your topic without having to
configure a remote.
It will also simplify the workflow when you are co-developing a branch.
When submitting a PR, make sure to add a Cc: @OpenwaterHealth/openlifudevelopers comment to
notify OpenLIFU developers of your awesome contributions. Based on the
comments posted by the reviewers, you may have to revisit your patches.
Getting your contributions integrated is relatively straightforward, here is the checklist:
- All tests pass
- Consensus is reached. This usually means that at least one reviewer added a
LGTMcomment and a reasonable amount of time passed without anyone objecting.LGTMis an acronym for Looks Good to Me.
Next, there are two scenarios:
- You do NOT have push access: A OpenLIFU core developer will integrate your PR.
- You have push access: Simply click on the "Merge pull request" button.
Then, click on the "Delete branch" button that appears afterward.