-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
30 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Prepare for release of HDMF [version] | ||
|
||
### Before merging: | ||
- [ ] Minor releases: Update package versions in `requirements.txt`, `requirements-dev.txt`, `requirements-doc.txt`, `requirements-min.txt` as needed. See https://requires.io/github/hdmf-dev/hdmf/requirements/?branch=dev | ||
- [ ] Check legal file dates and information in `Legal.txt`, `license.txt`, `README.rst`, `docs/source/conf.py`, and any other locations as needed | ||
- [ ] Update `setup.py` as needed | ||
- [ ] Update `README.rst` as needed | ||
- [ ] Update `src/hdmf/common/hdmf-common-schema` submodule as needed. Check the version number manually. | ||
- [ ] Update changelog (set release date) in `CHANGELOG.md` and any other docs as needed | ||
- [ ] Run tests locally including gallery tests and inspect all warnings and outputs (`python test.py -v > out.txt`) | ||
- [ ] Run PyNWB tests locally including gallery tests and inspect all warnings and outputs (`python test.py -v > out.txt`) | ||
- [ ] Test docs locally (`make apidoc`, `make html`) | ||
- [ ] Push changes to this PR and make sure all PRs to be included in this release have been merged | ||
- [ ] Check that the readthedocs build for this PR succeeds (build latest to pull the new branch, then activate and | ||
build docs for new branch): https://readthedocs.org/projects/hdmf/builds/ | ||
|
||
### After merging: | ||
1. Create release by following steps in `docs/source/make_a_release.rst` or use alias `git pypi-release [tag]` if set up | ||
2. After the CI bot creates the new release (wait ~10 min), update the release notes on the [GitHub releases page](https://github.com/hdmf-dev/hdmf/releases) with the changelog | ||
3. Check that the readthedocs "latest" and "stable" builds run and succeed | ||
4. Update [conda-forge/hdmf-feedstock](https://github.com/conda-forge/hdmf-feedstock) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,16 @@ | ||
--- | ||
name: Pull request | ||
about: Create a pull request to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Motivation | ||
|
||
What was the reasoning behind this change? Please explain the changes briefly. | ||
|
||
## How to test the behavior? | ||
``` | ||
Show here how to reproduce the new behavior (can be a bug fix or a new feature) | ||
Show how to reproduce the new behavior (can be a bug fix or a new feature) | ||
``` | ||
|
||
## Checklist | ||
|
||
- [ ] Have you checked our [Contributing](https://github.com/hdmf-dev/hdmf/blob/dev/docs/CONTRIBUTING.rst) document? | ||
- [ ] Have you ensured the PR description clearly describes problem and the solution? | ||
- [ ] Is your contribution compliant with our coding style ? This can be checked running `flake8` from the source directory. | ||
- [ ] Have you ensured the PR clearly describes the problem and the solution? | ||
- [ ] Is your contribution compliant with our coding style? This can be checked running `flake8` from the source directory. | ||
- [ ] Have you checked to ensure that there aren't other open [Pull Requests](https://github.com/hdmf-dev/hdmf/pulls) for the same change? | ||
- [ ] Have you included the relevant issue number using `#XXX` notation where `XXX` is the issue number ? By including "Fix #XXX" you allow GitHub to close the corresponding issue. | ||
- [ ] Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters