From b5131cff6aede1517e2df1f1d50330f0c144d1a1 Mon Sep 17 00:00:00 2001 From: Zachariah Dzielinski <dzielinski_zachariah@bah.com> Date: Wed, 13 Jan 2021 11:27:17 -0700 Subject: [PATCH] docs: added conventional commit docs --- CONTRIBUTING.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc1ddd6c68..89f985f04b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,11 @@ Big Bang is designed in such a way as to be as easily deployed locally as it is ### Pre-commit hooks -We would like developers to leverage [conventional commits](https://www.conventionalcommits.org/) when contributing. In order to help enforce this we are leveraging client-side pre-commit hooks. This is done using the following tools: +We would require developers to leverage [conventional commits](https://www.conventionalcommits.org/) when contributing. + +In order to help enforce this we are leveraging client-side pre-commit hooks. + +This is done using the following tools: - [husky](https://www.npmjs.com/package/husky) - [commitlint](https://commitlint.js.org/#/) @@ -62,6 +66,16 @@ This will download `husky` and `commitlint` to your local repo and modify your ` If you have pushed commits that do not conform to the conventional-commit guide lines, you can combine all of the incorrectly formatted commit messages by using `git rebase`. A more expansive guide of how this is done can be found [here](https://www.w3docs.com/snippets/git/how-to-combine-multiple-commits-into-one-with-3-steps.html). +Here is a quick tip to squash all commits for a branch named `test`: + +``` +git checkout test +git reset $(git merge-base $CI_DEFAULT_BRANCH $(git rev-parse --abbrev-ref HEAD)) +git add -A +git commit -m \"feat: example conventional commit\" +git push --force +``` + ## Iron Bank Images Per the [charter](https://repo1.dsop.io/platform-one/big-bang/charter), all Big Bang packages will leverage container images from [IronBank](https://ironbank.dsop.io/). In order to pull these images, ImagePullSecrets must be provided to BigBang. To obtain access to these images, follow the guides below. These steps should NOT be used for production since the API keys for a user are only valid when the user is logged into [Registry1](https://registry1.dsop.io) -- GitLab