Charlie Egan
b29b1dad76
* Add markdownlint tooling to docs Install markdownlint-cli2 with configuration file and make targets for auto fix etc too. Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Autofixable markdown issues mainly, replace tabs with spaces for consistent 2-space indentation Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD059 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Fix a number of <link> issues Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD041 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD041 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD046 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD025 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD052 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD028 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * MD001 Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Add GH action check in PRs Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Use 4 spaces for tabs Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Use 4 spaces for tabs Signed-off-by: Charlie Egan <charlie_egan@apple.com> * docs: Add spell checking using Vale Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Correct comment for space indentation rule Signed-off-by: Charlie Egan <charlie_egan@apple.com> --------- Signed-off-by: Charlie Egan <charlie_egan@apple.com>
3.4 KiB
title, sidebar_label
| title | sidebar_label |
|---|---|
| Contributing to OPA | Introduction |
Thanks for your interest in contributing to the Open Policy Agent project! There are all sorts of ways to get involved, whether you are a user of OPA or interested in contributing.
:::info Most of the discussions about OPA take place on Slack, if you haven't already, you can sign up here. :::
I'd like to help OPA users
Most users ask in the #help channel in Slack, hang out in there and see if there are any questions you can help with.
You might also want to keep an eye on the
OPA Discussion Board or
on the #rego tag on Stack
Overflow.
I'd like to contribute code
If you have found a bug and would like to work on a fix, we always encourage you file a GitHub Issue to talk about the problem and the solution you have in mind. This allows you to get feedback from maintainers before committing time to something that might already have a solution or might not be the right approach.
If you have an idea for a new feature, we also request that you file an issue to discuss it first. This again allows you to get feedback from the maintainer team and the community before you start working on it.
If you'd like to work on an existing issue that's been stale for quite some time, it's a good idea to comment on the issue first to check if it's still relevant, and if there are additional details that might have emerged since it was last updated.
If you want to chat to the maintainers before opening an issue or about anything else, head over to #contributors in Slack. This is also a great place to ask for ideas if you want to contribute, but aren't sure what to work on!
If you are ready to start contributing code, please see our Contributing Code guide for pointers on how to get started. Please note we have some restrictions around the use of AI tooling which are documented here.
I'd like to help improve the documentation
Great! Please see our Contributing Documentation guide for more details.
I have an OPA project or talk I'd like to share
Awesome! For OPA-based projects, we have our Ecosystem page. This is a great place to showcase your project and how it uses OPA.
You can create a markdown file in:
docs/src/data/ecosystem/entries
and add an icon in
/docs/static/img/ecosystem-entry-logos
to have your project listed on the ecosystem page.
If you have a talk or blog you'd like to share please feel free to post in:
- #ecosystem in Slack.
- Ecosystem Discussions on GitHub.
I'm interested in something else
Sounds interesting, we'd love to hear all about it, sign up for our Slack and drop a message in the #contributors channel.