Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.8 KB

Contributing

First off, thank you for considering contributing to Keptn. It's people like you that make Keptn great.

Where do I go from here?

If you've noticed a bug, want to contribute features, or simply ask a question that for whatever reason you don't want to ask in the Keptn Slack workspace, please search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one.

Read the docs

We are in the process of making sure that each repository and each service within the Keptn organization is documented properly. We are aware that some parts are currently missing, in the meantime please get in touch with us through the Keptn Slack workspace if you have any questions.

As a starting point, please read the docs within the docs/ folder in this repository.

Fork and create a branch

For Keptn, we are following the git branching model described in this blog post, however we try to avoid the extra step of the develop branch, and instead work directly on the master branch.

If you work on a new feature or on a bugfix, then fork the repository and branch away from the master branch and use the following schema for naming your branches:

  • feature/###/name for new features,
  • patch/###/name for patches,
  • bug/###/name for bugfixes, and
  • hotfix/###/name for hotfixes (e.g., for releases),

where ### is the github issue id. E.g., if you work on feature based on issue #123, the branch name could be

  • feature/123/foo.
git checkout master
git pull
git checkout -b feature/123/foo

For Hotfixes please branch away from the master branch, and create a PR to master and the respective release branches.

Run Tests

Currently Keptn has only limited automated end-to-end tests. To verify Keptn still works as it's supposed to, please make sure that the tutorials described on the Keptn website can be completed successfully.

Make a Pull Request

At this point, you should switch back to the master branch in your repo, and make sure it's up to date with Keptn's master branch:

git remote add upstream [email protected]:keptn/keptn.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it.

git checkout feature/123/foo
git rebase master
git push --set-upstream origin feature/123/foo

Finally, go to GitHub and make a Pull Request. Please describe what this PR is about and add a link to relevant GitHub issues. Your PR will usually be reviewed automatically, but feel free to let us know about your PR via Slack.