[DOC] Improve Editors-in-chief guidelines
acocac opened this issue · comments
Describe the proposed improvement to the documentation
The guidelines for EiC would benefit for adding further instructions, in particular for the postprint stage.
-
Review
- Check conversations in the REVIEW issue
- For open discussions, check latest message of the editor. If editor says ok but missing to resolve, type closing conversation, resolved and then click on Resolve Conversation
- If everything ok, type "The notebook is good to go -- the reviewed version is available in the [BRANCH-NAME] branch and is ready to create a postprint branch"
- Check conversations in the REVIEW issue
-
Postprint
-
Repository Preparation
- Rename the custom repository name with a UUID
- Create postprint branch from the main branch
- Edit README with the UUID-based name
- Check executed notebook in the preview branch
-
Submodule
- Import the submodule
git submodule add -b render [REPO-PATH]
- Import the submodule
-
PR
- Add checklist
- Before review:
- Add submodule from the notebook repo
- Add new submodule path to
_toc.yml
- Add card of the new notebook
- Add references
- Hide code cell content of some sections e.g. Libraries, Tables, Last tested
- Check menu right-panel looks ok (headings)
- Once reviewed/approved:
- Replace binder url, postprint to main
- Replace submodule branch, preview to render
- Generate and add badges of DOI in the notebook file and gallery
- Add authors/reviewers via all-contributors
- Before review:
- Formatting and versioning
nbqa black notebook.ipynb
- check formatted lines
- Add checklist
-