CONTRIBUTING.md

Contributing to EKG

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

The following is a set of guidelines for contributing to the EKG. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a Pull Request.

Your Pull Request will be reviewed by one of the maintainers. We encourage and welcome any and all feedback from the community.

Making a Pull Request

Please make a fork of the repo, and summit a PR from there. More information can be found here.

Prerequisites (that software has to be installed on developer's machine) - Node.js - Helm - Terraform - TFLint - terraform-docs

To update a part of the docs that is autogenerated from Terraform configuration (any changes in it may force docs update) run

ci/generate-docs.sh

and commit it to the repository (otherwise CI checks won't pass).

to install the required dependencies and ensure all checks pass, first perform the below command

npm install

And then run all checks, executing the following command

npm run check-all

which executes checks for spelling, markdown files, redundant whitespace, and up-to-date autogenerated documentation.

Configuration for them is in the below files

• package.json - what checks are available (you don't need to always run all of them locally)

• cspell.json - missing words can be added to the dictionary (please maintain alphabetical order, it is checked by a special check too)

• .markdownlint.json - rules can be adjusted for files with .md extension

Pull Request title

Try to be as descriptive as you can in your Pull Request title.