CONTRIBUTING.md

How to Contribute

Pull requests and issues are welcome! File an issue before opening a pull request so we can discuss.

Repository Structure

data-raw/corpus contains the raw text of the works. Any change to or addition/removal of datasets must be done in this directory.

The generate_data.R script automates creating the datasets and their accompanying documentation from the raw text files.

Thus the process for most changes will require updating the raw data or the generate_data.R script then running generate_data.R to generate changes to the datasets or docs.

Issues

Issues should provide details on bugs, dataset errors, or feature requests. Ensure there isn't already an open issue or pull request on your issue before opening.

Pull Requests

1. File an issue and wait for a reply before starting any work

2. Fork and clone the repo

3. Install the pre-commit hooks

4. Create a new branch

   git checkout -b my-branch

5. Make your changes

   • Run the generate_data.R script if you made changes to the raw text files or data documentation
   • Render README.md from README.qmd if you made changes to the README

6. Ensure R-CMD-check passes

   devtools::check()

7. Run the build_github_site.R script to preview the {pkgdown} site

8. Submit a PR