Skip to content

Commit 1bec88c

Browse files
authored
docs: Update contrib docs (#6974)
I have removed the references to the regular meetings, but also made a number of other updates to this page to make it clear where we need help and how to get started. Signed-off-by: Charlie Egan <[email protected]>
1 parent 3ac5104 commit 1bec88c

File tree

1 file changed

+49
-18
lines changed

1 file changed

+49
-18
lines changed

Diff for: docs/content/contributing.md

+49-18
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,59 @@ weight: 1
66

77
Thanks for your interest in contributing to the Open Policy Agent project!
88

9-
## Where to start?
9+
{{< info >}}
10+
Most of the discussions about OPA take place on Slack, if you haven't already,
11+
you can [sign up here](https://slack.openpolicyagent.org/).
12+
{{< /info >}}
1013

11-
* Ask for help on the [OPA Discussions Board](https://github.com/open-policy-agent/feedback/discussions)
12-
* Use [#contributors](https://openpolicyagent.slack.com/archives/C02L1TLPN59) in Slack to talk to the OPA maintainers and other contributors.
13-
* File a [GitHub Issue](https://github.com/open-policy-agent/opa/issues) to request features or report bugs.
14-
* Join the OPA bi-weekly meetings every other Tuesday at 10:00 (Pacific Timezone):
15-
* [Meeting Notes](https://docs.google.com/document/d/1v6l2gmkRKAn5UIg3V2QdeeCcXMElxsNzEzDkVlWDVg8/edit?usp=sharing)
16-
* [Zoom](https://zoom.us/j/97827947600)
17-
* [Calendar Invite](https://calendar.google.com/event?action=TEMPLATE&tmeid=MnRvb2M4amtldXBuZ2E1azY0MTJndjh0ODRfMjAxODA5MThUMTcwMDAwWiBzdHlyYS5jb21fY28zOXVzc3VobnE2amUzN2l2dHQyYmNiZGdAZw&tmsrc=styra.com_co39ussuhnq6je37ivtt2bcbdg%40group.calendar.google.com&scp=ALL)
14+
## I'd like to help OPA users
1815

16+
Most users ask in the [#help](https://openpolicyagent.slack.com/archives/CBR63TK2A)
17+
channel in Slack, hang out in there and see if there are any questions you
18+
can help with.
1919

20-
If you want to contribute code and you are new to the Go programming language, check out
21-
the [development reference](../contrib-development/) for help getting started.
20+
You might also want to keep an eye on the
21+
[OPA Discussion Board](https://github.com/orgs/open-policy-agent/discussions).
2222

23-
## Other types of contributions
23+
## I'd like to contribute code
2424

25-
We welcome contributions of all kinds. For example:
25+
If you have found a bug and would like to work on a fix, we still encourage you
26+
file a [GitHub Issue](https://github.com/open-policy-agent/opa/issues) first
27+
to talk about the problem and the solution you have in mind.
2628

27-
- [Documentation](../contrib-docs) including reference material and examples.
28-
- Help out other members in the OPA Slack Org and on the [GitHub Discussions Board](https://github.com/open-policy-agent/feedback/discussions)
29-
- Spreading the word about OPA by speaking at conferences
30-
- Adding integrations to the OPA [ecosystem](https://www.openpolicyagent.org/ecosystem/)
31-
- Creating Blog and Videos to show how your organization has implemented OPA
29+
Similarly, if you have an idea for a new feature, we encourage you to file an
30+
issue to discuss the feature before you start working on it too.
31+
32+
If you want to chat to the maintainers before opening an issue or about anything
33+
else, head over to
34+
[#contributors](https://openpolicyagent.slack.com/archives/C02L1TLPN59) in
35+
Slack.
36+
37+
If you want to contribute code check out the
38+
[development reference](../contrib-development/) for pointers on how to get
39+
started.
40+
41+
## I'd like to help improve the documentation
42+
43+
Great! Please see our [documentation page](../contrib-docs) for more details.
44+
45+
## I have an OPA project or talk I'd like to share
46+
47+
Awesome! For OPA-based projects, we have our [Ecosystem page](/ecosystem/).
48+
This is a great place to showcase your project. See
49+
[the instructions](https://github.com/open-policy-agent/opa/tree/main/docs#opa-ecosystem)
50+
here to get it listed.
51+
52+
If you have a talk or blog you'd like to share please feel free to post in:
53+
54+
- [#ecosystem](https://openpolicyagent.slack.com/archives/C02J6LBL6GH) in Slack.
55+
- [Ecosystem Discussions](https://github.com/orgs/open-policy-agent/discussions/categories/ecosystem) on GitHub.
56+
57+
## I'm interested in something else...
58+
59+
Sounds interesting, we'd love to hear all about it,
60+
[sign up for our Slack](https://slack.openpolicyagent.org/) and
61+
drop a message in the
62+
[#contributors](https://openpolicyagent.slack.com/archives/C02L1TLPN59)
63+
channel.
3264

33-
If you're interested in any non-code contributions, please reach out on the #help channel on [Slack](https://slack.openpolicyagent.org/)

0 commit comments

Comments
 (0)