CONTRIBUTING.adoc

Contributing

Requirements

This repository uses Conventional Commits for creating commit messages.

Please use following types to create your commits:

• feat, for a new functionality.

• fix, for a bug fixes.

• chore, for everything else ( CI/CD, docs, etc)

Also, we would like PRs to contain a single commit and be rebased onto main project master branch before submitting.

Git flow.

Although, you could choose your own approach to create branches, develop code and provide new PR, we recommend following.

1. Fork this project and clone it to local PC.

2. Add this project as a new remote named upstream.

   $ git remote add upstream https://github.com/eshepelyuk/cmak-operator.git
   $ git fetch upstream

3. Create a new branch, based on upstream master and push it to your repository.

   $ git checkout --no-track -b my-branch upstream/master
   $ git push -u origin my-branch

4. Develop your code locally, test and commit.

   $ git commit -am '.....'

5. Before pushing code to origin ensure your working branch is rebased onto upstream/master.

   $ git fetch upstream
   $ git rebase -i upstream/master

   During rebase, make your PR to be comprised of a single commit, unless, you really want to provide multiple commits via single PR.

6. Push your branch and create a PR via GitHub UI.

   $ git push -u -f origin my-branch