Skip to content

Commit 05f36cc

Browse files
Add PR template (emscripten-forge#4847)
1 parent e934787 commit 05f36cc

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Template A: Checklist for **adding** a package
2+
3+
### Pre-submission Checks
4+
- [ ] Package requires building for `emscripten-wasm32` platform (not a noarch package), in other words, the package requires compilation.
5+
6+
<!-- If you have a noarch package, we suggest submitting your recipe to https://github.com/conda-forge/staged-recipes/ instead. -->
7+
8+
### Recipe Structure
9+
Added `recipes/recipes_emscripten/[package-name]/recipe.yaml` with proper structure:
10+
- [ ] `context` section with `version` (and optionally `name`)
11+
- [ ] `package` section with name and version using Jinja2 templates
12+
- [ ] `source` section with:
13+
- Source URL is valid and points to archive file (`.tar.gz`, `.tar.bz2`, `.tar.xz`, `.tgz`, or `.zip`)
14+
- Source URL contains `${{ version }}` template for version updates
15+
- SHA256 hash is correct (verified with `curl -sL <url> | sha256sum`)
16+
- Patches (if any) are included in `[package-name]/patches/` directory
17+
- [ ] `build` section with appropriate script/method
18+
- Python packages: `${PYTHON} -m pip install . ${PIP_ARGS}`
19+
- R packages: `$R CMD INSTALL $R_ARGS .`
20+
- C++ packages: Uses `emcmake`/`emmake` or `emconfigure`/`emmake`
21+
- Rust packages: Uses `rust-nightly` and `maturin` or appropriate Rust build tool
22+
- Build number is 0
23+
- If the script is longer than 3 lines, a *build.sh* is included
24+
- [ ] `requirements` section (build, host, run as needed)
25+
- [ ] `tests` section
26+
- Python packages: `test_import_[package].py` file created and referenced
27+
- C++ packages: Test executable or package_contents test
28+
- R packages: Package contents test
29+
- [ ] `about` section with license, homepage, summary
30+
31+
---
32+
33+
## Template B: Checklist for **updating** a package
34+
35+
- [ ] ⚠️ Bump build number if the version remains unchanged
36+
- [ ] Or reset build number to 0 if updating the package to a newer version
37+
38+
---
39+
40+
## PR Formatting
41+
- [ ] PR title follows format: `Add [package-name]` or `Update [package-name] to [version]`
42+
- [ ] PR description includes:
43+
- Version being added/updated
44+
- Any special build considerations or patches applied
45+
46+
## Package Details
47+
- **Package Name**:
48+
- **Version**:
49+
50+
## Build Notes
51+
<!-- Any special build considerations, patches applied, or issues encountered -->
52+

0 commit comments

Comments
 (0)