Skip to content

Commit

Permalink
chore: document {devtag} in contributing guide (#1547)
Browse files Browse the repository at this point in the history
  • Loading branch information
aviator-app[bot] authored Oct 7, 2024
2 parents dc019bb + 49256b9 commit 01aeb63
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ please file an issue that illustrates the bug with a minimal [reprex](https://ww
(this will also help you write a unit test, if needed).
See the tidyverse guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice.

### Dependencies installation

To install all dependencies of igraph, including dependencies needed for development, call, from the root of the rigraph Git repository:

```r
# All Imports and Suggests dependencies
pak::pak()
# Then install packages like roxygen2 add-ons
pak::pak(dependencies = "Config/Needs/build")
```

### Pull request process

* Fork the package and clone onto your computer.
Expand All @@ -39,7 +50,8 @@ See the tidyverse guide on [how to create a great issue](https://code-review.tid

* We use [roxygen2](https://cran.r-project.org/package=roxygen2),
with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html),
for documentation.
for documentation.
We aspire to document internal functions using [devtag](https://github.com/moodymudskipper/devtag) (not all of them are thus documented yet).

* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
Please add test cases for the change you are proposing, or ask us for help.
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ LinkingTo:
cpp11 (>= 0.5.0)
VignetteBuilder:
knitr
Config/Needs/build: roxygen2, devtools, irlba, pkgconfig, igraph/igraph.r2cdocs, maelle/devtag@keywords-internal
Config/Needs/build: roxygen2, devtools, irlba, pkgconfig, igraph/igraph.r2cdocs, moodymudskipper/devtag
Config/Needs/coverage: covr
Config/Needs/website: readr
Config/testthat/edition: 3
Expand Down

0 comments on commit 01aeb63

Please sign in to comment.