Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

79 lines (49 loc) · 2.76 KB
Raw

Contributing to kconnect

Thank you for considering to contribute to kconnect 🎉👍

This document will provide help on how to go about this. You can contribute in the following ways:

  • Reporting bugs
  • Suggesting features
  • Contributing code

Reporting Bugs

Reporting bugs is an essential part in making kconnect better for its end users.

Bugs are reported using GitHub issues. A new Bug Report can be raised here.

When raising bugs please include as much information as possible including steps about how to reproduce the problem and what you expect the behavior to be.

Suggesting features

If there is a feature that you would like in kconnect then please let us know about it.

Features are also suggested using GitHub Issues. A new Feature enhancement request can be raised here.

Include as much information as possible, understanding the problem that the feature is trying to solve will really help us in understanding the benefit.

Contributing Code

Code contributions to kconnect are very welcome.

If you need a pointer on where to start you can look at the good first issue and help wanted issues:

You can also choose your own issue to work on from this list of available issues.

When choosing an issue to work on its preferable that you choose a issue that is planned for the next milestone and that has a higher priority....but this is just a nice to have and any contribution would be considered and welcomed.

Getting started

  1. Install Go >= 1.13
  2. Fork the kconnect repo
  3. Create a branch for your change:
git checkout -b <feature-name>
  1. Use git submodule for saml2aws third party dependency
git submodule update --init --recursive
  1. Make the change, including any additional tests
  2. Run the tests:
make test
  1. Check for linting errors:
make lint
  1. Build and manually test kconnect locally:
make build
  1. Commit and push your branch. We follow Conventional Commits for the commits and PRs. .
  2. Create a pull request. If the PR is a work in progress ensure that that PR is created as a draft.
  3. Check that the PR checks pass

Once a PR has been created it will be reviewed by one of the maintainers of kconnect.