diff options
| author | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2022-09-05 13:07:52 +0300 |
|---|---|---|
| committer | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2022-10-01 18:12:32 +0300 |
| commit | e0516ccc8a9e7807102539e1101fa0e290f476ba (patch) | |
| tree | 8ddc01783a04b6c96f6445eb281525f3c8583eba | |
| parent | e8bba94ea15c9e81fe5df23ca00547a4c6868e7e (diff) | |
| download | pysaml2-e0516ccc8a9e7807102539e1101fa0e290f476ba.tar.gz | |
docs: Update PR and issue templates
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
| -rw-r--r-- | .github/issue_template.md | 24 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 23 |
2 files changed, 29 insertions, 18 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md index 58967f57..b76ed50a 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,20 +1,22 @@ -<!--- Provide a general summary of the issue in the Title above --> +<!-- Provide a general summary of the issue in the Title above --> -## Code Version +### Code Version <!-- What version and/or branch of the code are you running? --> -## Expected Behavior -<!--- Tell us what should happen --> +### Expected Behavior +<!-- Tell us what should happen --> -## Current Behavior -<!--- Tell us what happens instead of the expected behavior --> +### Current Behavior +<!-- Tell us what happens instead of the expected behavior --> -## Possible Solution -<!--- Not obligatory, but suggest a fix/reason for the bug, --> +### Possible Solution +<!-- Not obligatory, but suggest a fix/reason for the bug, --> + +### Steps to Reproduce +<!-- Provide a link to a live example --> +<!-- or, an unambiguous set of steps to reproduce this bug --> +<!-- Include code to reproduce, if relevant --> -## Steps to Reproduce -<!--- Provide a link to a live example, or an unambiguous set of steps to --> -<!--- reproduce this bug. Include code to reproduce, if relevant --> 1. 2. 3. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 94be46df..f388ca27 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,20 @@ -### All Submissions: +### Description -* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change? -* [ ] Have you added an explanation of what problem you are trying to solve with this PR? -* [ ] Have you added information on what your changes do and why you chose this as your solution? -* [ ] Have you written new tests for your changes? -* [ ] Does your submission pass tests? -* [ ] This project follows PEP8 style guide. Have you run your code against the 'flake8' linter? +##### The feature or problem addressed by this PR +<!-- an explaination of the issue that is being resolved with this PR --> +<!-- or, an explaination of the feature that is being added with this PR --> +<!-- or, link to an issue describing the problem --> +##### What your changes do and why you chose this solution + +<!-- description of the technical changes that help resolve the issue --> + + +### Checklist + +* [ ] Checked that no other issues or pull requests exist for the same issue/change +* [ ] Added tests covering the new functionality +* [ ] Updated documentation OR the change is too minor to be documented +* [ ] Updated CHANGELOG.md OR changes are insignificant |