Skip to content

Commit

Permalink
Add Github Issue and PR templates (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
sjperkins authored Sep 12, 2024
1 parent cf8d712 commit 10deb8f
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
- xarray-ms version:
- Python version:
- Operating System:

### Description

Describe what you were trying to accomplish.
Tell us what happened, what went wrong, and what you expected to happen.

### Reproducer and Error Logs

```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
```
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Consider opening an
[enhancement issue](https://github.com/ratt-ru/xarray-ms/issues/new/choose)
if the change is large or complex.

We would appreciate it if you could add:

- [ ] Test Cases covering your PR.
- [ ] Documentation.
- [ ] A Changelog entry in `doc/source/changelog.rst`.

Development setup information is available [here](https://xarray-ms.readthedocs.io/en/latest/install.html#development).
3 changes: 2 additions & 1 deletion doc/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
Changelog
=========

0.2.1 (DD-MM-YYYY)
X.Y.Z (DD-MM-YYYY)
------------------
* Add Github Issue and PR templates (:pr:`17`)
* Improve key resolution (:pr:`15`)
* Add a basic tutorial (:pr:`13`)

Expand Down

0 comments on commit 10deb8f

Please sign in to comment.