-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into d_assistant_take_2
- Loading branch information
Showing
16 changed files
with
619 additions
and
236 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve contentctl | ||
title: "[BUG]" | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
|
||
### **Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
### **Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
### **Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
### **contentctl Version:** | ||
v5.0.0 | ||
|
||
### **Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
requests to ensure we have all the necessary information to effectively respond | ||
to your bug report or contribution. | ||
|
||
|
||
In addition to this document, review our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
For any code of conduct questions or comments, send an email to [email protected]. | ||
|
||
# First Things First | ||
|
||
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). | ||
|
||
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. | ||
|
||
# Contributor License Agreement | ||
|
||
Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html). | ||
Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html). | ||
|
||
## Ways to Contribute | ||
|
||
### Bug Reports | ||
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. | ||
|
||
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. | ||
|
||
### Feature Requests & Proposals | ||
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 | ||
|
||
### Documentation Changes | ||
|
||
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! | ||
|
||
### Contributing Code | ||
|
||
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. | ||
|
||
## Review Process | ||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Overview | ||
|
||
This document contains a list of maintainers in this repo. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). | ||
|
||
## Current Maintainers | ||
|
||
| Maintainer | GitHub ID | Affiliation | | ||
| ------------------ | --------------------------------------------------------- | ----------- | | ||
| Erick McGinnis | [pyth0n1c](https://github.com/pyth0n1c) | Splunk | | ||
| Patrick Bareiss | [P4T12ICK](https://github.com/P4T12ICK) | Splunk | | ||
| Lou Stella | [ljstella](https://github.com/ljstella) | Splunk | | ||
| Jose Hernandez | [josehelps](https://github.com/josehelps) | Splunk | | ||
|
||
|
||
## Emeritus | ||
|
||
| Maintainer | GitHub ID | Affiliation | | ||
| ------------------ | --------------------------------------------------------- | ----------- | |
Oops, something went wrong.