Merge pull request #199 from norwoodj/feat/improving-community-standards

docs: improving community standards

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,85 @@
+name: 🐞 Bug Report
+description: File a new bug report
+title: '[Bug]: <title>'
+labels: 
+  - "bug"
+  - "triage"
+assignees:
+  - "norwoodj"
+  - "Nepo26"
+body:
+  - type: markdown
+    attributes:
+      value: 'Thanks for taking the time to fill out this bug report!'
+  - type: checkboxes
+    attributes:
+      label: 'Is there an existing issue for this?'
+      description: 'Please [search :mag: the issues](https://github.com/norwoodj/helm-docs/issues) to check if this bug has already been reported.'
+      options:
+        - label: 'I have searched the existing issues'
+          required: true
+  - type: textarea
+    attributes:
+      label: 'Current Behavior'
+      description: 'Describe the problem you are experiencing.  **Please do not paste your logs here.**  Screenshots are welcome.'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 'Expected Behavior'
+      description: 'Describe what you expect to happen instead.'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 'Reference Chart'
+      description: |
+        Please provide an example chart, be it the full code or just a reference to a repository.
+        
+        > OBS.: :warning: _Remember to redact or remove any sensitive information!_
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: 'Reference Template'
+      description: |
+        If you are using a custom template, put it in here, so we can help you better.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: 'Environment'
+      description: 'Please provide the following information about your environment; feel free to remove any items which are not relevant.'
+      value: |
+        - Operating system:
+        - Helm version (output of `helm version`):
+        - GO version (output of `go version`):
+        - Method of calling `helm-docs` (manual, jenkins, github action ...):
+#TODO Add when the version function is implemented:
+# - **helm-docs** version (output of `helm-docs version`):
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: 'Link to `helm-docs` Logs'
+      description: |
+        Create a [Gist](https://gist.github.com)—which contains your _full_ `helm-docs` logs—and link it here.  Alternatively, you can attach a logfile to this issue (drag it into the "Further Information" field below).
+        
+        Remember to use the following flag `--log-level debug`
+        
+        > OBS.: :warning: _Remember to redact or remove any sensitive information!_
+      placeholder: 'https://gist.github.com/...'
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Further Information
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        _Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: ':stop_sign: _For support questions, you may create an issue with the question template._'

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,3 @@
+blank_issues_enabled: false
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,32 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feat]: <title>"
+labels: 
+  - enhancement
+assignees: 
+  - Nepo26
+
+---
+<!--- Provide a general summary of the issue in the Title above -->
+
+
+## Is your feature request related to a problem? Please describe and/or link to a bug issue
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+## Expected Behavior
+<!--- Tell us how it should work -->
+
+## Current Behavior
+<!--- Explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Ideas on how to implement the addition or change -->
+
+## Describe alternatives you've considered
+<!--- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+<!--- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,61 @@
+name: 🌟 Feature Request
+description: Suggest an idea for this project
+title: "[Feat]: <title>"
+labels:
+  - "enhancement"
+  - "triage"
+assignees:
+  - "norwoodj"
+  - "Nepo26"
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for the interest in the project! :blush:"
+  - type: textarea
+    attributes:
+      label: "General Summary"
+      description: "Provide a general summary of the issue in the Title above"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Is your feature request related to a problem? Please describe and/or link to a bug issue."
+      description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Expected Behavior"
+      description: "Tell us how it should work"
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: "Current Behavior"
+      description: "Explain the difference from current behavior"
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: "Possible Solution"
+      description: "Ideas on how to implement the addition or change"
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: "Alternatives you've considered"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Further Information
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+        
+        - How has this issue affected you? What are you trying to accomplish?
+        - Providing context helps us come up with a solution that is most useful in the real world
+        
+        _Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
+    validations:
+      required: false

.github/PULL_REQUEST_TEMPLATE/general_template.md

@@ -0,0 +1,27 @@
+## Proposed changes
+
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+## Types of changes
+
+What types of changes does your code introduce to `helm-docs`?
+_Put an `x` in the boxes that apply_
+
+- [ ] Bugfix (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)
+- [ ] Documentation Update (if none of the other choices apply)
+
+## Checklist
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I have read the [CONTRIBUTING](https://github.com/norwoodj/helm-docs/blob/master/CONTRIBUTING.md) doc
+- [ ] Lint and unit tests pass locally with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## Further comments
+
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

CONTRIBUTING.md

@@ -1,5 +1,19 @@
 # Contributing to helm-docs
 
+## Build
+To build from source in this repository:
+
+```bash
+cd cmd/helm-docs
+go build
+```
+
+Or you can install from source:
+
+```bash
+GO111MODULE=on go get github.com/norwoodj/helm-docs/cmd/helm-docs
+```
+
 ## Testing
 
 ### Benchmarks

SECURITY.md

@@ -0,0 +1,38 @@
+## Security
+
+We take this project and its users security seriously.
+
+If you believe you have found a security vulnerability in any part of this repo,
+please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them in the [private vulnerability reporting](https://github.com/norwoodj/helm-docs/security/advisories).
+
+If you prefer to submit without logging in, send email to [norwood.john.m@gmail.com](mailto:norwood.john.m@gmail.com) or
+[nepo26.hn@gmail.com](mailto:nepo26.hn@gmail.com).  
+
+[//]: # ( If possible, encrypt your message with our PGP key )
+[//]: # (TODO Create a public PGP key and make it available for anyone that needs it )
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to
+ensure we received your original message.
+
+Please include the requested information listed below (as much as you can provide) to help us better 
+understand the nature and scope of the possible issue:
+
+* Type of issue (e.g. buffer overflow, etc.)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+
+We prefer all communications to be in English.