Contributing📜
If you are coming from repo1.dso.mil
and have an account at login.dso.mil
please keep reading. If you are coming from or looking for the project on Github and wanting to make a Pull Request without a dso.mil
account please see External Github Contributions.
This repository uses the following conventions:
- Semantic Versioning
- Keep a Changelog
- Conventional Commits
- Cypress or shell scripts for testing
Development requires the following tools
To contribute a change:
- Open an issue in GitLab describing the scope of your work
- Assign yourself to the issue
- Label the issue with
status::doing
- Create a branch in the repository using your issue number as a prefix
- Make changes in code and push to your branch
- Write tests using cypress and/or shell scripts to cover your changes.
- Make commits using the Conventional Commits format
- Update
CHANGELOG.md
using the Keep a Changelog format - Open a merge request into the
main
branch - Add a reference to the issue in the merge request description
- Resolve any failures from the pipeline
- Resolve any merge conflicts
- Label the Merge Request with
status::review
- Contact the code owners to expedite your Merge Request review
- Address any review comments and merge conflicts during the review process
- Wait for a code owner to approve and merge your changes
- Request a repository maintainer to create a release and tag
Last update:
2023-11-13 by Sean Thomas