Merge pull request #991 from neXenio/update-pr-template

feat(gh): update issue forms and contribution setup

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,114 @@
+name: Bug Report
+description: File a bug report
+title: "[bug]: "
+labels: ["bug"]
+body:
+  # information
+  - type: markdown
+    attributes:
+      value: | 
+        Thanks for taking the time to fill out this bug report!
+        *Note:* Please search to see if an issue already exists for the bug you encountered.
+  # bug description
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Description of the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  # steps to reproduce
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Steps to reproduce the behavior. Also provide parts of your inventory, if it's neccessary.
+      placeholder: Tell us what steps you did to encounter the bug!
+      render: bash
+      value: |
+        1. 
+        2. 
+        3. 
+        4. 
+    validations:
+      required: true
+  # expected behavior
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear and concise description of what you expected to happen.
+      placeholder: Tell us what you'd expect to happen.
+    validations:
+      required: true
+  # additional context
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: | 
+        Add any other context about the problem here.
+        If applicable, you can add screenshots to help explain your problem.
+      placeholder: Anything that might help us understanding your problem...
+  # section environment
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+  # kapitan version
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version (kapitan)
+      description: |
+        Which version of kapitan are you running? 
+        If you are using an older version of kapitan, please try it against the master branch or the latest stable version.
+      options:
+        - v0.31.0 (stable)
+        - master
+      multiple: true
+    validations:
+      required: true
+  # python version
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Version (kapitan)
+      description: |
+        Which version of python are you using? Kapitan officially supports only version 3.8 and 3.9. 
+        If you are using an older version of python, please check if the bug still exists with a newer (supported) version.
+      options:
+        - '3.8'
+        - '3.9'
+        - 3.10 (future)
+        - I use kapitan directly (pip, docker)
+      multiple: true
+    validations:
+      required: true
+  # python virtual environment
+  - type: checkboxes
+    id: python-venv
+    attributes:
+      label: Python virtual environment
+      description: Are you using pyenv or virtualenv?
+      options:
+        - label: pyenv
+        - label: venv
+        - label: no environment
+  # os information
+  - type: input
+    id: os-information
+    attributes:
+      label: OS information
+      description: Which operation system do you use?
+      placeholder: Type in your operation system...
+  # logs
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: | 
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        Use the `--verbose` flag to see all the logs.
+      render: bash

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,29 @@
+name: Feature Request
+description: Request a new functionality
+title: "[feat]: "
+labels: ["feature"]
+body:
+  # information
+  - type: markdown
+    attributes:
+      value: | 
+        Thanks for taking the time to fill out this feature request!
+  # feature description
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Description of the feature
+      description: |
+        A clear and concise description of what the feature request is. 
+        Please make proposals, how you would use this feature (syntax).
+      placeholder: Tell us what you want to see in the project!
+    validations:
+      required: true
+  # additional context
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: | 
+        Add any other context about the feature here.
+      placeholder: Anything that might help us understanding your feature request...

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+Fixes #
+
+## Proposed Changes
+
+*
+
+## Docs and Tests
+
+* [ ] Tests added
+* [ ] Updated documentation

docs/pages/contribute/code.md

@@ -17,21 +17,27 @@ targeting master branch. All submissions, including submissions by project membe
 
 ### Setup
 
-We highly recommend that you create a dedicated Python environment for Kapitan.
-There are multiple solutions:
+We build kapitan using `poetry`.
 
-* [pyenv](https://github.com/pyenv/pyenv)
-* [virtualenv](https://virtualenv.pypa.io/en/latest/)
-* [venv](https://docs.python.org/3/library/venv.html)
+1. Install poetry
 
-Once you've done it, please install all Kapitan's dependencies:
+    ```bash
+    pip install poetry
+    ```
 
-```shell
-python3 -m venv env
-source env/bin/activate
-pip3 install black # required for `make test_formatting`
-pip3 install -r requirements.txt
-```
+2. Install dependencies
+
+    ```bash
+    poetry install --with test
+    ```
+
+    Poetry creates a virtual environment with the required dependencies installed.
+
+3. Run kapitan with the own compiled code
+
+    ```bash
+    poetry run kapitan <your command>
+    ```
 
 Because we are using a pinned version of reclass which is added as a submodule into Kapitan's
 repository, you need to pull it separately by executing the command below:

docs/pages/contribute/documentation.md

@@ -25,7 +25,9 @@ Updating our gh-pages is therefore a two-step process.
 
 Submit a PR for our master branch that updates the `.md` file(s). Test how the changes would look like when deployed to gh-pages by serving it on localhost:
 
-`make local_serve_documentation`
+1. Edit the `strict` property in `mkdocs.yml` and set it to `false`.
+2. `make local_serve_documentation`
+3. Now the documentation site should be available at [`localhost:8000`](http://127.0.0.1:8000).
 
 ### Submit a PR