You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+29-1Lines changed: 29 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,38 @@ our community. Read through this document before submitting any issues or pull
6
6
requests to ensure we have all the necessary information to effectively respond
7
7
to your bug report or contribution.
8
8
9
+
9
10
In addition to this document, review our [Code of Conduct](CODE_OF_CONDUCT.md).
10
11
For any code of conduct questions or comments, send an email to [email protected].
11
12
13
+
# First Things First
14
+
15
+
1.**When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when it doubt, [open an issue](https://github.com/splunk/contentctl/issues).
16
+
17
+
2.**Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit.
12
18
13
19
# Contributor License Agreement
14
20
15
-
Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html).
21
+
Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html).
22
+
23
+
## Ways to Contribute
24
+
25
+
### Bug Reports
26
+
Bugs! Ugh! When there's a mismatch between intended behavior, and the actual results, that's a bug. To help us understand what's happening, we want to make sure you're working on the latest version.
27
+
28
+
Once you've confirmed that the bug still exists in the latest version, check to make sure its not something we already know about on the [Github Issues tab](https://github.com/splunk/contentctl/issues). When you open a bug, please fill out the issue template for a bug report, supplying as much relevant information as you can.
29
+
30
+
### Feature Requests & Proposals
31
+
If you've thought of a way that `contentctl` can be better, we want to hear about it! There's a specific issue type for these requests [here](https://github.com/splunk/contentctl/issues) that helps us keep track. Please describe the feature you'd want to see, and if possible, a potential implementation idea. If you're not familiar enough with the codebase to describe the implementation, that's fine too
32
+
33
+
### Documentation Changes
34
+
35
+
Sometimes, the documentation doesn't match reality. Sometimes, examples might be out of date, or spelling or grammar might make something difficult to read or understand. We welcome updates to our documentation for any of the above reasons, and for any others too!
36
+
37
+
### Contributing Code
38
+
39
+
As with other types of contributions, please open an issue first. This helps to make sure we don't have duplicate people working on the same problem, ensures that the change is solved once, and that we can help you find the right approach before spending a ton of time on a PR. As above, when in doubt, please open an issue.
40
+
41
+
## Review Process
42
+
We're very appreciative of everyone that wants to make a contribution. We will attempt to review them in a timely manner. As a reminder, opening [an issue](https://github.com/splunk/contentctl/issues) before you spend time on a PR can help make this process smoother. It can also help prevent rejection because someone else was working on it already, or because its incompatible with other in-flight work or long term goals.
0 commit comments