From 569270e1c2d70b5a38772c2bf7f3caa55e68f351 Mon Sep 17 00:00:00 2001 From: dilpath Date: Wed, 17 Apr 2024 14:42:14 +0200 Subject: [PATCH] move checklist to PR template --- CONTRIBUTING.md | 15 +-------------- pull_request_template.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 14 deletions(-) create mode 100644 pull_request_template.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8e415d..dcf35c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1 @@ -# Checklist for the submission of new problems -- [ ] The PEtab problem is valid (check with e.g. `petablint -vy problem.yaml`) -- The problem is setup to quickly reproduce figures from the original paper, by including - - [ ] A PEtab visualization file - - [ ] Simulated data generated by simulating the PEtab problem with parameters from the original paper -- [ ] The problem name follows the following convention: `{LAST_NAME_OF_FIRST_AUTHOR}_{ABBREVIATED_JOURNAL_NAME}{YEAR_OF_PUBLICATION}` -- [ ] The PEtab problem is based on a model that is - - [ ] peer-reviewed and - - [ ] published -- [ ] The model ID and model name attributes in the SBML model file match the problem name -- [ ] Any information related to methods used with the PEtab problem to reproduce work from the original paper is included in the PR, e.g.: - - [ ] Optimization method and hyperparameters -- [ ] There is an identifier tag to contains a reference to the original publication -- [ ] The README has been updated with “python scripts/overview.py --update” +New submissions are very welcome! Please check `pull_request_template.md` for guidelines. diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..d8e415d --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,14 @@ +# Checklist for the submission of new problems +- [ ] The PEtab problem is valid (check with e.g. `petablint -vy problem.yaml`) +- The problem is setup to quickly reproduce figures from the original paper, by including + - [ ] A PEtab visualization file + - [ ] Simulated data generated by simulating the PEtab problem with parameters from the original paper +- [ ] The problem name follows the following convention: `{LAST_NAME_OF_FIRST_AUTHOR}_{ABBREVIATED_JOURNAL_NAME}{YEAR_OF_PUBLICATION}` +- [ ] The PEtab problem is based on a model that is + - [ ] peer-reviewed and + - [ ] published +- [ ] The model ID and model name attributes in the SBML model file match the problem name +- [ ] Any information related to methods used with the PEtab problem to reproduce work from the original paper is included in the PR, e.g.: + - [ ] Optimization method and hyperparameters +- [ ] There is an identifier tag to contains a reference to the original publication +- [ ] The README has been updated with “python scripts/overview.py --update”