From dd91d91be0d0d35887ee94be96f2ac617af77726 Mon Sep 17 00:00:00 2001 From: Jordan Bradford <36420801+jrdnbradford@users.noreply.github.com> Date: Tue, 30 Jul 2024 12:05:56 -0400 Subject: [PATCH] Fix contributing links (#40) --- .github/CONTRIBUTING.md | 12 ++++++------ DESCRIPTION | 2 +- NEWS.md | 4 +++- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e96863b..5596430 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,11 +2,11 @@ Pull requests and issues are welcome! File an issue before opening a pull request so we can discuss. ## 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. +[`data-raw/corpus`](https://github.com/jrdnbradford/lovecraftr/tree/main/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/). +The [`generate_data.R`](https://github.com/jrdnbradford/lovecraftr/tree/main/data-raw/generate_data.R) script automates creating the datasets and their [accompanying documentation](https://github.com/jrdnbradford/lovecraftr/tree/main/R/data.R) from the [raw text files](https://github.com/jrdnbradford/lovecraftr/tree/main/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. +Thus the process for most changes will require updating the raw data or the [`generate_data.R` script](https://github.com/jrdnbradford/lovecraftr/tree/main/data-raw/generate_data.R) then running [`generate_data.R`](https://github.com/jrdnbradford/lovecraftr/tree/main/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. @@ -26,8 +26,8 @@ Issues should provide details on bugs, dataset errors, or feature requests. Ensu 1. Make your changes - * 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` + * Run the [`generate_data.R`](https://github.com/jrdnbradford/lovecraftr/tree/main/data-raw/generate_data.R) script if you made changes to the raw text files or data documentation + * Render [`README.md`](https://github.com/jrdnbradford/lovecraftr/tree/main/README.md) from [`README.qmd`](https://github.com/jrdnbradford/lovecraftr/tree/main/README.qmd) if you made changes to the `README` 1. Ensure [R-CMD-check](https://devtools.r-lib.org/reference/check.html) passes @@ -35,6 +35,6 @@ Issues should provide details on bugs, dataset errors, or feature requests. Ensu devtools::check() ``` -1. Run the [`build_github_site.R` script](../data-raw/build_github_site.R) to preview the {`pkgdown`} site +1. Run the [`build_github_site.R` script](https://github.com/jrdnbradford/lovecraftr/tree/main/data-raw/build_github_site.R) to preview the {`pkgdown`} site 1. Submit a PR diff --git a/DESCRIPTION b/DESCRIPTION index e06fdbb..5299d2d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: lovecraftr Type: Package Title: H. P. Lovecraft's works, for text analysis -Version: 1.0.0 +Version: 1.0.0.9000 Authors@R: person("Jordan", "Bradford", email = "jrdnbradford@gmail.com", role = c("aut", "cre")) Description: A collection of H. P. Lovecraft's works as R datasets. diff --git a/NEWS.md b/NEWS.md index 288bf90..f961f2a 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,7 @@ # lovecraftr 1.0.0.9000 (Development Version) -No development changes (yet). + +## Documentation +Fix broken links in `CONTRIBUTING` on GitHub site (#40) # 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.