From 9fea754261e2ed80defd9cc9eda54223031f5544 Mon Sep 17 00:00:00 2001 From: Alex Ouzounis Date: Tue, 9 Jun 2020 11:25:18 +0100 Subject: [PATCH] doc: add templates (#140) * doc: add templates * doc: add templates * doc: add templates * fix: typo * fix: add metadata for pr template * fix: typo --- .github/ISSUE_TEMPLATE/bug_report.md | 45 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 40 ++++++++++++++++++++ CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 32 ++++++++++++++++ 5 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2b11c22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. + + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..7ddc5f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1929b22 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index bf809a0..9e7aa7f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at team@ouzi.dev. All +reported by contacting the project team at oss@ouzi.dev. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..db43ccf --- /dev/null +++ b/CONTRIBUTING.md @@ -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 \ No newline at end of file