|
1 | | - |
2 | 1 | # Contribution Guide |
3 | 2 |
|
| 3 | +There are many ways to contribute to CUE without writing code! |
4 | 4 |
|
5 | | -The CUE project welcomes all contributors, and there are many ways that you can |
6 | | -contribute that don't involve writing code! |
7 | | - |
8 | | -This document guides you through the process of contributing to the CUE project. |
9 | | - |
10 | | - |
11 | | -### How can I contribute to the CUE project? |
12 | | - |
13 | | -There are many ways that you can contribute to the CUE project |
14 | | -that don't involve writing code. |
15 | | - |
16 | | -* Using CUE is a form of contributing! Especially when combined with raising |
17 | | - issues, providing feedback, tell us what works well and what doesn't, pointing |
18 | | -out gaps etc. |
19 | | -* Adding your CUE-based project to [Unity](https://cuelabs.dev/unity/) |
20 | | - helps ensure that we don't create releases that unintentionally break |
21 | | -configurations, but also gives a wide variety of scenarios in which to test bug |
22 | | -fixes, performance improvements and the like. |
23 | | -* Asking questions via GitHub discussions/Slack. This might seem somewhat |
24 | | - counterintuitive, but asking questions helps to identify gaps in |
25 | | -documentation, or poor signposting from the CUE homepage. |
26 | | -* Raising issues with bug reports and feature requests helps us to raise the |
27 | | - quality of future CUE releases. In the case of bug reports not least because |
28 | | -it provides us with real-world test cases. |
29 | | -* Helping to manage issues and answer discussions. Sometimes referred to as |
30 | | - "issue gardening", this helps to share the load of triaging new issues and |
31 | | -feature requests. Having issues presented in a familiar "shape", format and |
32 | | -voice is a _massive_ time saver when it comes to one of the core contributors |
33 | | -fixing a bug, or considering a new feature. |
34 | | -* Code contributions, the main focus of this guide. The CUE project is a little |
35 | | - different from that used by other open source projects so we cover this |
36 | | -process in more detail below. |
| 5 | +* Ask or answer questions via GitHub discussions, Slack, and Discord |
| 6 | +* Raise issues such as bug reports or feature requests on GitHub |
37 | 7 | * Contributing thoughts and use cases to proposals. CUE can be and is |
38 | 8 | being used in many varied different ways. Sharing experience reports helps |
39 | 9 | to shape proposals and designs. |
40 | | -* Creating content. Whether it be writing blog posts, live streaming, |
41 | | - tweeting... creating content is a great way of growing the CUE community. |
42 | | -Different people have different ways of explaining things, and very often these |
43 | | -different styles appeal to different people. That said, if you think there is |
44 | | -core documentation or guides missing from the https://cuelang.org website |
45 | | -[please raise an issue to let us |
46 | | -know](https://github.com/cue-lang/cue/issues/new/choose): there is not |
47 | | -substitute for good core content, and it means others are then free to write |
48 | | -about more interesting use cases and applications for CUE. |
49 | | -* Holding community events. Whether they be virtual online events or |
50 | | - (COVID-allowing) in-person meetups, sharing experiences about using CUE is a |
51 | | -very valuable way of learning for many. |
52 | | - |
53 | | -Thank you to everyone who contributes to the CUE community in whatever form! |
54 | | -Whilst GitHub doesn't have a good means of tracking contributions outside of |
55 | | -code contributions, your contributions are greatly valued! |
56 | | - |
| 10 | +* Create content: share blog posts, tutorials, videos, meetup talks, etc |
| 11 | +* Add your project to [Unity](https://cuelabs.dev/unity/) to help us test changes to CUE |
57 | 12 |
|
58 | 13 | ## Before contributing code |
59 | 14 |
|
|
0 commit comments