Skip to contents

Contributing to EdSurvey

Source: .github/CONTRIBUTING.md

These steps outline how to propose a change to EdSurvey.

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.

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 reproducible example.

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("American-Institutes-for-Research/EdSurvey", 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.

Documentation and testing

R code style guide

  • We encourage contributors to follow our general R Code Style Guide when suggesting code changes.

Code of Conduct

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