Skip to content

Commit

Permalink
Fix contributing links (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrdnbradford committed Jul 30, 2024
1 parent bc40dd9 commit dd91d91
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
12 changes: 6 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -26,15 +26,15 @@ 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

```R
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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]", role = c("aut", "cre"))
Description: A collection of H. P. Lovecraft's works as R datasets.
Expand Down
4 changes: 3 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit dd91d91

Please sign in to comment.