Skip to content

Commit

Permalink
add issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram committed Nov 14, 2023
1 parent 54bc6ca commit 25631ca
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!--
Thank you for opening an issue for asdf!
Your feedback is crucial to maintaining this open source project.
If this is a feature request or discussion question please add to
or create a new discussion:
https://github.com/asdf-format/asdf/discussions
-->

# Description of the problem

<!-- If an Exception, Warning or some other error occurred please include
the error message and full traceback -->

# Example of the problem

<!-- Please include an example that reproduces the problem or describe why
an example isn't provided. -->

# System information

asdf version:
python version:
operating system:
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!---
Thanks for contributing to asdf!
Your PR should trigger the CI (after approval for first-time contributors)
which will:
- check your code for 'style' using pre-commit
- run your PR against the asdf unit tests for various OSes, python versions, and dependency versions
- perform a test build of your PR
It is highly recommended that you run some of these tests locally by:
- [installing pre-commit](https://pre-commit.com/#quick-start)
- [running pytest](https://docs.pytest.org/en/7.1.x/getting-started.html)
This will increase the chances your PR will pass the required CI tests.
-->

# Description

<!--
Please describe what this PR accomplishes.
If the changes are non-obvious, please explain how they work.
If this PR adds a new feature please include tests and documentation.
If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX')
-->

# Checklist:

- [ ] pre-commit checks ran successfully
- [ ] tests ran successfully
- [ ] for a public change, a changelog entry was added
- [ ] for a public change, documentation was updated
- [ ] for any new features, unit tests were added

0 comments on commit 25631ca

Please sign in to comment.