This guide is intended for contributors tagged as reviewers on a pull request or have triage, write, or maintainer roles on the SeaLion Mission ConOps repo.
We use the github flow for managing this repository. At a glance, this means:
-
a main branch. This branch MUST be releasable at all times. New branches should be created from this branch. Pull requests made to this branch should be linked to one or more issues.
Issues are tracked using the GitHub issue tracker. See Quickstart for GitHub Issues.
Issue triaging responsibilities include:
-
Labeling Issue. Labels are used to identify a category, in order to narrow the scope and subject matter of an open issue. See Adding labels.
-
Resolving duplicates. Newly reported duplicate issues can be resolved using the
duplicatelabel. -
Adding to a milestone. Issues can be included as part of an existing milestone. See Adding milestones.
-
Adding to a project. Issues can be included as part of an existing project. See Adding the issue to a project.
-
Communicating. Contributors are encouraged to engage conversation in the form of comments on an issue. See Communicating.
To review a pull request,
-
Verify that the pull request is linked to one or more issues. See Linking a pull request to an issue.
-
Verify that the contents of a pull request conforms to the Content style guide.
-
Verify that the contents of a pull request adequately resolves its linked issues.
-
Verify that the version number reflects any updates to the architecture/ or components/. See Semantic versioning.
-
Provide comments, approval, or request for changes. See About pull request reviews.
Releases are decided by the maintainers, such as upon completion of a milestone. See Managing releases in a repository
Commits with updates to the version should be tagged with a tag name corresponding to its version number. See Semantic versioning and Managing tags.