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

[DOC] Improve Editors-in-chief guidelines #185

Open
acocac opened this issue Aug 23, 2023 · 0 comments
Open

[DOC] Improve Editors-in-chief guidelines #185

acocac opened this issue Aug 23, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@acocac
Copy link
Member

acocac commented Aug 23, 2023

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"
  • 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]
    • 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
      • Formatting and versioning
        • nbqa black notebook.ipynb
          • check formatted lines

Additional information

@acocac acocac added the documentation Improvements or additions to documentation label Aug 23, 2023
@acocac acocac self-assigned this Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant