Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PR template #150

Open
2 tasks
SabineHaas opened this issue Feb 23, 2022 · 2 comments
Open
2 tasks

Add PR template #150

SabineHaas opened this issue Feb 23, 2022 · 2 comments
Milestone

Comments

@SabineHaas
Copy link
Collaborator

To prevent errors like explained in #148 it would be nice to add a PR template containing (maybe among other things) a check list about what has to be done before a merge.

  • run simulation with xxx data / scenario ..
  • run examples
@jnnr
Copy link
Collaborator

jnnr commented Mar 1, 2022

Add a reminder to fill the changelog and give advice how to describe fixes and features there.

@jnnr jnnr added this to the Someday milestone May 20, 2022
@MaGering MaGering modified the milestones: Someday, v0.0.4 Sep 20, 2023
@MaGering
Copy link
Collaborator

Example from digipipe repo:

Fixes #

## Before merging into `dev`-branch, please make sure that the following points are checked:

- [ ] All pre-commit tests passed locally with: `pre-commit run -a`
- [ ] File `CHANGELOG.md` was updated
- [ ] The docs were updated
  - [ ] if `dataset.md`s were updated, the dataset docs were regenerated using
    `python docs/generate_dataset_mds.py`

If packages were modified:
- [ ] File `poetry.lock` was updated with: `poetry lock`
- [ ] A new env was successfully set up

WARNING: When modifying use snakemake <=7.32.0, cf. #186

If data flow was adjusted:
- [ ] Data pipeline run finished successfully with: `snakemake -jX`
- [ ] Esys appdata was created successfully with: `snakemake -jX make_esys_appdata`

  (with `X` =  desired number of cores, e.g. 1)

@MaGering MaGering modified the milestones: v0.0.4, v0.0.5 Nov 21, 2023
@MaGering MaGering modified the milestones: v0.0.5, v0.0.6 Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants