|
1 | | -### Description |
| 1 | +<!-- |
| 2 | + Thanks for contributing to Wasp! |
| 3 | + Make sure to follow this PR template, so that we can speed up the review process. |
| 4 | + It will also help you not forget important steps when making a change. |
| 5 | + If you don't know how to fill any of the sections below, it's okay to leave |
| 6 | + them blank and ask for help. |
| 7 | +--> |
2 | 8 |
|
3 | | -> Describe your PR! If this PR closes an issue, use “Fixes #(issue_number)" syntax so GitHub will auto-close it when merged. |
| 9 | +## Description |
4 | 10 |
|
5 | | -### Select what type of change this PR introduces: |
| 11 | +Replace this message here, and write a high-level overview with any additional |
| 12 | +context (motivation, trade-offs, approaches considered, concerns, ...). |
6 | 13 |
|
7 | | -1. [ ] **Just code/docs improvement** (no functional change). |
8 | | -2. [ ] **Bug fix** (non-breaking change which fixes an issue). |
9 | | -3. [ ] **New feature** (non-breaking change which adds functionality). |
10 | | -4. [ ] **Breaking change** (fix or feature that would cause existing functionality to not work as expected). |
| 14 | +## Type of change |
11 | 15 |
|
12 | | -### Update Waspc ChangeLog and version if needed |
| 16 | +<!-- Select just one with [x] --> |
13 | 17 |
|
14 | | -If you did a **bug fix, new feature, or breaking change**, that affects `waspc`, make sure you satisfy the following: |
| 18 | +- [ ] **🔧 Just code/docs improvement** <!-- no functional change --> |
| 19 | +- [ ] **🐞 Bug fix** <!-- non-breaking change which fixes an issue --> |
| 20 | +- [ ] **🚀 New/improved feature** <!-- non-breaking change which adds functionality --> |
| 21 | +- [ ] **💥 Breaking change** <!-- fix or feature that would cause existing functionality to not work as expected --> |
15 | 22 |
|
16 | | -1. [ ] I updated [`ChangeLog.md`](https://github.com/wasp-lang/wasp/blob/main/waspc/ChangeLog.md) with description of the change this PR introduces. |
17 | | -2. [ ] I bumped `waspc` version in [`waspc.cabal`](https://github.com/wasp-lang/wasp/blob/main/waspc/waspc.cabal) to reflect changes I introduced, with regards to the version of the latest wasp release, if the bump was needed. |
| 23 | +## Checklist |
18 | 24 |
|
19 | | -### Add a regression test if needed |
| 25 | +<!-- |
| 26 | + Check all the applicable boxes with [x], and leave the rest empty. |
| 27 | + If you're unsure about any of them, don't hesitate to ask for help. |
| 28 | +--> |
20 | 29 |
|
21 | | -If you did a **bug fix**, make sure you satisfy the following: |
| 30 | +- [ ] I tested my change in a Wasp app to verify that it works as intended. |
22 | 31 |
|
23 | | -1. [ ] I added a regression test that reproduces the bug and verifies the fix. |
| 32 | +- 🧪 Tests and apps: |
24 | 33 |
|
25 | | -If you're unable to add a regression test, please explain why. |
26 | | -This likely indicates that our current testing setup needs improvement. |
| 34 | + - [ ] I added **unit tests** for my change. <!-- If not, explain why. --> |
| 35 | + - [ ] _(if you fixed a bug)_ I added a **regression test** for the bug I fixed. <!-- If not, explain why. --> |
| 36 | + - [ ] _(if you added/updated a feature)_ I added/updated **e2e tests** in `examples/kitchen-sink/e2e-tests`. |
| 37 | + - [ ] _(if you added/updated a feature)_ I updated the **starter templates** in `waspc/data/Cli/templates`, as needed. |
| 38 | + - [ ] _(if you added/updated a feature)_ I updated the **example apps** in `examples/`, as needed. |
| 39 | + - [ ] _(if you updated `examples/tutorials`)_ I updated the tutorial in the docs (and vice versa). |
27 | 40 |
|
28 | | -### Test Coverage |
| 41 | +- 📜 Documentation: |
29 | 42 |
|
30 | | -Please ensure your changes are adequately tested: |
| 43 | + - [ ] _(if you added/updated a feature)_ I **added/updated the documentation** in `web/docs/`. |
31 | 44 |
|
32 | | -1. [ ] **My changes are covered by tests** (unit, integration, or e2e tests as appropriate). |
| 45 | +- 🆕 Changelog: _(if change is more than just code/docs improvement)_ |
| 46 | + - [ ] I updated `waspc/ChangeLog.md` with a **user-friendly** description of the change. |
| 47 | + - [ ] _(if you did a breaking change)_ I added a step to the current **migration guide** in `web/docs/migration-guides/`. |
| 48 | + - [ ] I **bumped the `version`** in `waspc/waspc.cabal` to reflect the changes I introduced. |
33 | 49 |
|
34 | | -If you're unable to add tests or if coverage is partial, please explain why below: |
| 50 | +<!-- |
| 51 | + Bumping the version on `waspc/waspc.cabal`: |
35 | 52 |
|
36 | | -<!-- Provide explanation here if tests are missing or incomplete --> |
| 53 | + We still haven't reached 1.0, so the version bumping follows these rules: |
| 54 | + - Bug fix: 0.X.+1 (e.g. 0.16.3 bumps to 0.16.4) |
| 55 | + - New feature: 0.X.+1 (e.g. 0.16.3 bumps to 0.16.4) |
| 56 | + - Breaking change: 0.+1.0 (e.g. 0.16.3 bumps to 0.17.0) |
37 | 57 |
|
38 | | -### Update example apps if needed |
39 | | - |
40 | | -If you did code changes and **added a new feature**, make sure you satisfy the following: |
41 | | - |
42 | | -1. [ ] I updated [`waspc/examples/todoApp`](https://github.com/wasp-lang/wasp/tree/main/waspc/examples/todoApp) and its e2e tests as needed and manually checked it works correctly. |
43 | | - |
44 | | -If you did code changes and **updated an existing feature**, make sure you satisfy the following: |
45 | | - |
46 | | -1. [ ] I updated [`waspc/examples/todoApp`](https://github.com/wasp-lang/wasp/tree/main/waspc/examples/todoApp) and its e2e tests as needed and manually checked it works correctly. |
47 | | - |
48 | | -### Update starter apps if needed |
49 | | - |
50 | | -If you did code changes and **updated an existing feature**, make sure you satisfy the following: |
51 | | - |
52 | | -1. [ ] I updated [starter skeleton](https://github.com/wasp-lang/wasp/tree/main/waspc/data/Cli/templates/skeleton) as needed and manually checked it works correctly. |
53 | | -2. [ ] I updated [`basic` starter](https://github.com/wasp-lang/wasp/tree/main/waspc/data/Cli/templates/basic) as needed and manually checked it works correctly. |
54 | | -3. [ ] I updated [`todo-ts` starter](https://github.com/wasp-lang/starters/tree/dev/todo-ts) as needed and manually checked it works correctly. |
55 | | -4. [ ] I updated [`embeddings` starter](https://github.com/wasp-lang/starters/tree/dev/embeddings) as needed and manually checked it works correctly. |
56 | | -5. [ ] I updated [`saas` starter](https://github.com/wasp-lang/open-saas/tree/main/template) as needed and manually checked it works correctly. |
57 | | - |
58 | | -### Update e2e tests if needed |
59 | | - |
60 | | -If you did code changes and changed Wasp's code generation logic, make sure you satisfy the following: |
61 | | - |
62 | | -1. [] I updated [e2e tests](https://github.com/wasp-lang/wasp/tree/main/waspc#end-to-end-e2e-tests) as needed and manually checked they are correct. |
| 58 | + If the version has already been bumped on `main` since the last release, skip this. |
| 59 | +--> |
0 commit comments