generated from ouzi-dev/bigbang
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* doc: add templates * doc: add templates * doc: add templates * fix: typo * fix: add metadata for pr template * fix: typo
- Loading branch information
1 parent
13c879a
commit 9fea754
Showing
5 changed files
with
141 additions
and
1 deletion.
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,45 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve Credstash Operator | ||
title: '' | ||
labels: blocked-needs-validation, bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Submit object with contents | ||
``` | ||
... | ||
``` | ||
2. Wait 1 minute | ||
3. No Secret object created | ||
4. See error in logs | ||
``` | ||
... | ||
``` | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Credstash Operator version used** | ||
The Credstash operator version from the [releases section](https://github.com/ouzi-dev/credstash-operator/releases). | ||
|
||
**Method of deployment** | ||
Helm chart or YAML? If YAML please provide sample yaml objects used to deploy. | ||
|
||
**Kubernetes API Version** | ||
The version of the Kubernetes API where the Operator is deployed. | ||
|
||
**Logs** | ||
If applicable, add logs to help explain your problem. | ||
|
||
**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,23 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest a new feature for Credstash Operator | ||
title: '' | ||
labels: blocked-needs-validation, enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the feature** | ||
A clear and concise description of the feature. | ||
|
||
**What would the new user story look like?** | ||
How would the new interaction with Credstash Operator look like? E.g. | ||
1. What are the prerequisites for this? | ||
2. User starts up Credstash Operator using the --new-feature flag | ||
3. User submits CredstashSecret object with extra parameter new-feature | ||
4. New Secret created using the new feature | ||
|
||
Feel free to add a diagram if that helps explaining things. | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expect to happen. |
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,40 @@ | ||
--- | ||
name: Pull Request | ||
about: Suggest a new feature for Credstash Operator | ||
title: '' | ||
labels: blocked-needs-validation, enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
# Pull Request Template | ||
|
||
Ensure that the Pull Request title starts with: | ||
- `feat: ` if its a major feature, | ||
- `fix: ` if its a minor one, | ||
- `doc: ` if its documentation related. | ||
Note: if you are still working on the changeset but wish to share with us your progress so far, please prepend `WIP` on your title. | ||
|
||
## Description | ||
|
||
Include a summary of the change and which issue is fixed. Please also include relevant context to help us understand the motivation behind the change. | ||
|
||
Fixes # (issue if applicable) | ||
|
||
## Type of change | ||
|
||
Please delete options that are not relevant. | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
## Checklist: | ||
|
||
- [ ] My code passes golint | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] I have added tests that show my fix is effective or that my feature works | ||
- [ ] New and existing unit tests pass locally with my changes | ||
- [ ] I have checked my code and corrected any misspellings |
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
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,32 @@ | ||
## How to contribute to Credstash Operator | ||
|
||
#### **Did you find a bug?** | ||
|
||
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/ouzi-dev/credstash-operator/issues). | ||
|
||
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ouzi-dev/credstash-operator/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
|
||
* For a more detailed description of what should a bug report contain, have a look at the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md). | ||
|
||
#### **Do you want to add an enhancement?** | ||
|
||
* If this is a feature request, have a look at the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) | ||
* If you wish to contribute and submit a patch with the enhancement, feel free to go ahead and skip the issue creation. We would still recommend creating a feature request if the enhancement requires significant changes such that we can discuss the changes before any significant time is spent developing them. | ||
|
||
#### **Did you write a patch that fixes a bug or adds a feature ?** | ||
|
||
* Open a new GitHub pull request with the patch. | ||
|
||
* Ensure the PR description clearly describes the problem and solution. | ||
Make sure the title of the PR starts with: | ||
- `feat: ` if its a major feature, | ||
- `fix: ` if its a minor one, | ||
- `doc: ` if its documentation related. | ||
Include the relevant issue number if applicable. | ||
|
||
* Before submitting, please ensure that golint passes and test cases have been added for the relevant changes. | ||
* Once submitted, a member of the Ouzi team will reach out for the next steps. | ||
|
||
Thanks! :heart: :heart: :heart: | ||
|
||
Ouzi Team |