Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 2.31 KB
Raw

Contributing to Kangal

👍🎉 First off all, thanks for taking the time to contribute! 🎉👍

The project is currently in the maintenance mode, which means we don't actively implement new features. We accept the external contribution after the discussions in GitHub issues.

Kangal is currently maintained by HelloFresh.

Contribution options

Create an issue

First of all, create a GitHub issue. It can be a feature request, a bug or simply a question. Before creating a new issue, please check if something similar was already reported. Then you can continue the existing discussion. To read more about GitHub issues please address to the official issue documentation.

How to submit a bug report?

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe your environment and the exact steps to reproduce the problem.
  • Describe the behavior you observe.
  • Describe the behavior you expect.

Issue decision

As the maintainers, we are willing to accept issues that would:

  • Address bugs and security vulnerabilities, improve design and performance
  • Fulfil internal business needs
  • Fulfil strong use cases from the community

We try to avoid introducing unnecessary complexity to the project codebase and want to make sure that newly implemented features will be utilized.

In case of a dissent we reserve the right to have the final decision based on our project priorities.

Create a PR

Important: Please wait for the reply of the maintaining team, before creating a PR.

Pull requests expectations

  • Keep the PR short. We will ask you to split the big PRs (with 10 files amd more) to the several small PRs to reduce the cognitive load when reviewing it.
  • Include unit tests covering your changes and new functionality.
  • Document the changes in the related documentation files
  • Follow the Go style guides.
  • End files with a newline.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.