CONTRIBUTING.md

In kenshuri/targets-tuto: Targets Tutorial

Contributing

Development is a community effort, and we welcome participation.

Code of Conduct

By participating in this project, you agree to abide by the code of conduct.

Issues

Anyone can submit an issue to https://github.com/wlandau/targets-tutorial/issues or comment on an existing thread. Common reasons are to

• Suggest features.
• Report bugs.
• Request help with difficult use cases.
• Ask questions.

Please abide by the following guidelines.

• Before posting a new issue, please take a moment to search for existing similar issues in order to avoid duplication.
• For bug reports: if you can, please install the latest GitHub version of targets (i.e. remotes::install_github("ropensci/targets")) and verify that the issue still persists.
• Describe your issue in prose as clearly and concisely as possible.
• Be considerate of the maintainer's time and make it as easy as possible to troubleshoot any problems you identify. Read here and here to learn about minimal reproducible examples. Format your code according to the tidyverse style guide to make it easier for others to read.

Development

External code contributions are extremely helpful in the right circumstances. Here are the recommended steps.

1. Prior to contribution, please propose your idea in a new issue thread so you and the maintainer can define the intent and scope of your work.
2. Fork the repository.
3. Follow the GitHub flow to create a new branch, add commits, and open a pull request.
4. Discuss your code with the maintainer in the pull request thread.
5. If everything looks good, the maintainer will merge your code into the project.

Please also follow these additional guidelines.

• Respect the architecture and reasoning of the project.
• If possible, keep contributions small enough to easily review manually. It is okay to split up your work into multiple pull requests.
• Format your code according to the tidyverse style guide.
• Describe your contribution in the project's NEWS.md file. Be sure to mention relevent GitHub issue numbers and your GitHub name as done in existing news entries.
• If your description is substantial, add yourself as an author or contributor in AUTHORS.md.

kenshuri/targets-tuto documentation built on April 19, 2021, 9:58 a.m.