Skip to contents

Contributing to energyRt

Source: .github/CONTRIBUTING.md

This outlines how to propose a change to energyRt. For a detailed discussion on contributing to this and other tidyverse packages, please see the development contributing guide and our code review principles.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed). See our guide on how to create a great issue for more advice.

Pull request process

  • Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("optimal2050/energyRt", fork = TRUE).

  • Install all development dependencies with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.

  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

  • For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

Code style

  • New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.

  • We use roxygen2, with Markdown syntax, for documentation.

  • We use testthat for unit tests. Contributions with test cases included are easier to accept.

AI-assisted contributions

AI-assisted contributions are welcome. We ask three things:

  • Disclose it. Say in the pull request description that AI assistance was used, and roughly for what (drafting, refactoring, tests, documentation). Commit trailers such as Co-authored-by: or Assisted-by: are fine as provenance metadata.

  • You are responsible for it. As the submitter you take the same responsibility for AI-assisted code as for any code you did not write from scratch: that you have the right to contribute it, that it is compatible with the package licence (AGPL-3), and that it is correct. Please review generated code rather than pasting it, and make sure the test suite passes.

  • Read AGENTS.md first. It lists the project conventions and the traps that fail silently in this codebase — constructors that return empty objects, templates that need a sysdata rebuild, S3 methods that never register. Generated code that ignores these tends to look right and behave wrong. Pointing your tool at that file up front saves a review cycle.

Note that AI tools are not listed as package authors. Authorship implies accountability for the work, so credit for a contribution goes to the person who submitted and vouched for it. See AUTHORS.md for how authorship and contribution are recorded.

Code of Conduct

Please note that the energyRt project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.