Skip to content

Commit dadf17e

Browse files
committed
add necessary instructions to release checklist and pack proposal
1 parent 4acb1ff commit dadf17e

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

.github/ISSUE_TEMPLATE/new_pack_proposal.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ assignees: ""
1616
- [ ] Create a requirements file by running `touch requirements/packs/<your-pack-name>.txt`. List all dependencies for your pack.
1717
- [ ] (OPTIONAL) Create a directory to place your examples, if applicable, by running `mkdir docs/examples/<your-pack-name>/<your-example-name>`.
1818
- [ ] (OPTIONAL) Copy your example scripts and data under the directory you just made. If you have multiple examples, house them under their own separate directory (i.e. `.../<your-pack-name>/example1` and `.../<your-pack-name>/example2`).
19+
- [ ] (OPTIONAL) Make a file under `docs/source/tutorial/` call `<your-pack-name>.rst` with `cp docs/source/tutorial/core.rst docs/source/tutorial/<your-pack-name>.rst`. Add your examples to the file in the same format as listed.
1920
- [ ] List your pack and its dependencies under `docs/source/available-packs.rst` using the same format as the other packs. In this same file, add a description of your pack (1-2 sentences is recommended).
2021
- [ ] Give yourself credit by listing your name and contributors to the pack you've created!
2122

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ labels: "release"
66
assignees: ""
77
---
88

9-
### Run diffpy.cmi example scripts
9+
### checklist for diffpy.cmi
1010

1111
- [ ] Manually trigger the `validate-examples.yml` workflow to run all example scripts.
12+
- [ ] Make sure available examples, packs, and profiles are listed in the docs. Check this by installing locally with `pip install .`, building the docs with `cmi install docs && cd docs && make html && open build/html/index.html`, running `cmi info`, and comparing the output to what is listed under "Examples" in the docs.
1213

1314
### PyPI/GitHub rc-release preparation checklist:
1415

0 commit comments

Comments
 (0)