Skip to content

Centralise guidelines for authors #14

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

Merged
merged 1 commit into from
Jul 21, 2025
Merged

Conversation

astamm
Copy link
Member

@astamm astamm commented May 27, 2025

TODO list:

  • Add guidelines for handling dependencies in Python and Julia;
  • Improve explanations of the use of setup-env-ci.sh and setup-render-ci.sh files;
  • Use shortcode {{< include guidelines-authors.qmd >}} in template repos to have the same guidelines propagated into the README of the templates or better, clean README content and point to the Guidelines for authors page;
  • Rework “Submit” tab;
  • A pass at example template contents for accuracy and to avoid saying things already said in guidelines?
  • Remove “How to automatically publish the HTML of my contribution to a website?” From the FAQ ?
  • Change title of first section into A step-by-step guide to submitting…
  • Add link to template repos in the 3-column table.
  • Add information about repository ownership transfer.

@NelleV
Copy link
Member

NelleV commented May 27, 2025

  • Rajouter les liens vers les templates dans la section Examples papers

@astamm
Copy link
Member Author

astamm commented Jul 21, 2025

@astamm
Copy link
Member Author

astamm commented Jul 21, 2025

Choses à peut-être préciser selon Manon :

  • Quand on utilise le template pour créer le repo git, pas besoin de prendre toutes les branches;
  • Expliquer qu'on peut modifier le _quarto.yml pour tout ce qui est entête, abstract etc.;
  • Comme il y a déjà un lockfile renv, quand on fait renv::init(), il faut choisir ce qu'on veut faire; peut-être pas évident pour les gens qui n'ont pas utilisé renv avant: documenter de choisir option 2;
  • La version du build.yml est différente sur la guideline-authors et sur celle du template, celle du template a les permissions d'écriture:
permissions:
      id-token: write
      contents: write
      pages: write
  • Il faut que le repo git soit public pour pouvoir utiliser GitHub pages
  • Les collaborateurs doivent refaire le quarto add extension computo

@fradav fradav merged commit 5bbeb95 into master Jul 21, 2025
2 checks passed
@astamm
Copy link
Member Author

astamm commented Jul 21, 2025

  • Explain that it is possible to use multiple languages provided that we use the knitr engine.

@astamm
Copy link
Member Author

astamm commented Jul 22, 2025

  • More details in Submit your manuscript section.

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

Successfully merging this pull request may close these issues.

3 participants