👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to the OpenSLO Spec. 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, and we won't bite. We encourage and welcome any and all feedback from the community.
Use the button Join our Slack from the official website openslo.com.
Please make a fork of the repo, and summit a PR from there. More information can be found here. Ensure that checks pass, perform
make install/checks/spell-and-markdownto install required dependencies to perform the below command
make run/checks/spell-and-markdownwhich executes checks for spelling, markdown files and redundant whitespaces. Configuration for them is in the below files:
-
cspell.json - missing words can be added to the dictionary (please maintain alphabetical order)
-
.markdownlint.json - rules can be adjusted
Try to be as more descriptive as you can in your Merge Request title.
Apache 2.0, see LICENSE.