Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 3.86 KB
Raw

Contributing to f1-2021-analysis

This outlines how to propose a change to f1-2021-analysis. Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.

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.

Report bugs

If you’ve found a bug, please first check if there is already an open issue for the bug. If there is, please add your comments to the issue to minimize redundancy. Otherwise, please include the following information when reporting the bug:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

If possible, please include in the issue a minimal reprex (this will also help you write a unit test, if needed).

Fix bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

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("UBC-MDS/f1-2021-analysis", 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.

Code of Conduct

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