Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: document {devtag} in contributing guide #1547

Merged
merged 2 commits into from
Oct 7, 2024
Merged

chore: document {devtag} in contributing guide #1547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
408302b
chore: depend on upstream devtag now that my PR was merged
maelle Oct 7, 2024
49256b9
chore: document {devtag} in contributing guide
maelle Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading