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

Developer guidelines #40

Open
fnattino opened this issue Dec 16, 2024 · 4 comments
Open

Developer guidelines #40

fnattino opened this issue Dec 16, 2024 · 4 comments

Comments

@fnattino
Copy link
Contributor

  • Describe release procedure (update DESCRIPTION and NEWS.md - only header ideally..)
  • Add template for PR to add line to NEWS.md
  • Are new contributors also authors? both DESCRIPTION and CITATION.cff file should be updated (right now they are already not synced!)
@fnattino
Copy link
Contributor Author

Also related #36

@cforgaci
Copy link
Contributor

cforgaci commented Dec 17, 2024

See usethis helper functions for creating contributing guidelines, the code of conduct and issue template: https://usethis.r-lib.org/reference/tidyverse.html

For the PR template, see my suggestion in CityRiverSpaces/CRiSp#56

@cforgaci
Copy link
Contributor

cforgaci commented Dec 17, 2024

  • Describe release procedure (update DESCRIPTION and NEWS.md - only header ideally..)
  • Are new contributors also authors? both DESCRIPTION and CITATION.cff file should be updated (right now they are already not synced!)

These are guidelines for the maintainer. Where are these usually written down?

@fnattino
Copy link
Contributor Author

I would still include them in the developers guide, maybe as a separate section.

See e.g. the developers guide for a big Python project (Iris): https://scitools-iris.readthedocs.io/en/latest/developers_guide/contributing_getting_involved.html

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

2 participants