Merge pull request #39 from jrdnbradford/v1-release

V1 release

.Rbuildignore

@@ -12,3 +12,4 @@
 ^docs$
 ^pkgdown$
 ^vignettes/*_files$
+^vignettes/.quarto$

.github/CONTRIBUTING.md

@@ -1,7 +1,18 @@
 # How to Contribute
-Contributions, issues, and fixes are welcome!
+Pull requests and issues are welcome! File an issue before opening a pull request so we can discuss.
 
-> If making changes to data, this must be done to the [raw txt files](../data-raw/corpus/). The [`generate_data.R`](../data-raw/generate_data.R) script automates creating the RDA files and accompanying documentation.
+## Repository Structure
+[`data-raw/corpus`](../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`](../data-raw/generate_data.R) script automates creating the datasets and their [accompanying documentation](../R/data.R) from the [raw text files](../data-raw/corpus/).
+
+Thus the process for most changes will require updating the raw data or the [`generate_data.R` script](../data-raw/generate_data.R) then running [`generate_data.R`](../data-raw/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](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) and wait for a reply before starting any work
 
 1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the repo
 
@@ -15,13 +26,15 @@ Contributions, issues, and fixes are welcome!
 
 1. Make your changes
 
-    * Run the [`generate_data.R`](../data-raw/generate_data.R) script if you made changes to the raw txt files or data documentation
+    * Run the [`generate_data.R`](../data-raw/generate_data.R) script if you made changes to the raw text files or data documentation
     * Render [`README.md`](../README.md) from [`README.qmd`](../README.md) if you made changes to the `README`
 
-1. Ensure all {[`testthat`](https://testthat.r-lib.org/)} tests pass
+1. Ensure [R-CMD-check](https://devtools.r-lib.org/reference/check.html) passes
 
     ```R
-    devtools::test()
+    devtools::check()
     ```
 
+1. Run the [`build_github_site.R` script](../data-raw/build_github_site.R) to preview the {`pkgdown`} site
+
 1. Submit a PR

.gitignore

@@ -1,7 +1,47 @@
-.Rproj.user
+# History files
 .Rhistory
+.Rapp.history
+
+# Session Data files
 .RData
+.RDataTmp
+
+# User-specific files
 .Ruserdata
 
+# Example code in package build process
+*-Ex.R
+
+# Output files from R CMD build
+/*.tar.gz
+
+# Output files from R CMD check
+/*.Rcheck/
+
+# RStudio files
+.Rproj.user/
+
+# produced vignettes
+vignettes/*.html
+vignettes/*.pdf
+
+# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
+.httr-oauth
+
+# knitr and R markdown default cache directories
+*_cache/
+/cache/
+
+# Temporary files created by R markdown
+*.utf8.md
+*.knit.md
+
+# R Environment Variables
+.Renviron
+
+# pkgdown site
+docs/
+
+# Quarto folder
 /.quarto/
-docs
+inst/doc

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: lovecraftr
 Type: Package
 Title: H. P. Lovecraft's works, for text analysis
-Version: 0.2.4
+Version: 1.0.0
 Authors@R:
     person("Jordan", "Bradford", email = "[email protected]", role = c("aut", "cre"))
 Description: A collection of H. P. Lovecraft's works as R datasets.
@@ -11,8 +11,11 @@ License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 Depends:
-    R (>= 2.10)
+    R (>= 3.5)
 Suggests:
-    testthat (>= 3.0.0),
+    knitr,
+    rmarkdown,
+    testthat (>= 3.0.0)
 Config/testthat/edition: 3
 RoxygenNote: 7.3.2
+VignetteBuilder: knitr

NEWS.md

@@ -0,0 +1,18 @@
+# lovecraftr 1.0.0.9000 (Development Version)
+No development changes (yet).
+
+# lovecraftr 1.0.0
+The release of 1.0.0 signals a stable API and base infrastructure on which to maintain the datasets and documentation.
+
+## Documentation
+* `vignettes/copyright-status.Rmd` explains copyright status of works
+* `NEWS.md`, this file, documents changes
+* updates to `README`
+* addition of lifecycle and R package version badges
+* `CONTRIBUTING.md` has been overhauled
+
+## Tooling
+* `generate_data.R` adds reference to `copyright-status.Rmd` to dataset documentation, along with a few other minor updates
+
+## Datasets
+* datasets now use version 3 RDA serialization format