Contributing

Thanks for contributing to this repository!

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
• Policy Naming Guide
• Scripted framework for testing. See the Testing Documentation for details.

Development requires the following tools

• kubectl
• helm
• fluxcd

To contribute a change:

1. Open an issue in GitLab describing the scope of your work
2. Assign yourself to the issue
3. Label the issue with proper status kind priority and team
4. Ensure the issue has proper Milestone and Iteration
5. Create a branch in the repository using your issue number as a prefix
6. Make changes in code and push to your branch
7. Write test cases by following the testing documentation.
8. Make commits using the Conventional Commits format
9. Update CHANGELOG.md using the Keep a Changelog format
10. Open a merge request into the main branch
11. Add a reference to the issue in the merge request description
12. Label the merge request with status kind priority and team
13. Ensure the merge request has proper Milestone
14. Resolve any failures from the pipeline
15. Resolve any merge conflicts
16. Label the Merge Request with status::review
17. Contact the code owners to expedite your Merge Request review
18. Address any review comments and merge conflicts during the review process
19. Wait for a code owner to approve and merge your changes
20. Request a repository maintainer to create a release and tag