diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.md b/.github/workflows/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..c4934fcd --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To reproduce** +Steps to reproduce the behavior: + +> Ex. +> +> 1. Install stactools +> 2. Run `scripts/test` +> 3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots and shell session dumps** +If applicable, add session dumps and/or screenshots to help explain your problem. + +> ex. `scripts/lint >> lint_errors.txt` + +**Additional context** +Add any other context about the problem here. diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.md b/.github/workflows/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..e0fce9d6 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. Ex. I would like to use stac to do [...] + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE.MD b/.github/workflows/PULL_REQUEST_TEMPLATE.MD new file mode 100644 index 00000000..ae4bce6e --- /dev/null +++ b/.github/workflows/PULL_REQUEST_TEMPLATE.MD @@ -0,0 +1,15 @@ +Before you submit a pull request, please fill in the following: + +**Related Issue(s):** +Please add links (if any) to related github issues. + +**Description:** +Please explain the changes you made here. + +**PR checklist:** + +- [ ] Code is formatted (run `scripts/format`). +- [ ] Code lints properly (run `scripts/lint`). +- [ ] Tests pass (run `scripts/test`). +- [ ] Documentation has been updated to reflect changes, if applicable. +- [ ] Changes are added to the [CHANGELOG](../CHANGELOG.md). diff --git a/CHANGELOG.md b/CHANGELOG.md index 4984aefb..c0b19ac0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +### Added + +- Added Issue and PR Templates +### Fixed + +### Changed +### Removed + ## stactools 0.2.1a1 ### Added