Skip to content

Commit

Permalink
chores: and
Browse files Browse the repository at this point in the history
  • Loading branch information
c1au6i0 committed Nov 20, 2024
1 parent 32b5cfb commit 46cc7d5
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 21 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@
^vignettes/*_files$
^README\.Rmd$
^README\.html$
^cran-comments\.md$
47 changes: 47 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to condathis

This outlines how to propose a change to condathis.
For a detailed discussion on contributing to this and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/).

## Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file.
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file.
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.

## Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed.
If you’ve found a bug, please file an issue that illustrates the bug with a minimal
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice.

### Pull request process

* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("luciorq/condathis", fork = TRUE)`.

* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.

* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
The title of your PR should briefly describe the change.
The body of your PR should contain `Fixes #issue-number`.

* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>.

### Code style

* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.

* 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.

* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
Contributions with test cases included are easier to accept.

## Code of Conduct

Please note that the condathis project is released with a
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
project you agree to abide by its terms.
34 changes: 14 additions & 20 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,17 @@ Package: condathis
Title: Run Any CLI Tool on a Conda Environment
Version: 0.0.6.9008
Authors@R: c(
person(given = "Lucio",
family = "Queiroz",
role = c("aut", "cre", "cph"),
email = "[email protected]",
person("Lucio", "Queiroz", , "[email protected]", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0002-6090-1834")),
person(given = "Claudio",
family = "Zanettini",
role = c("aut", "ctb"),
email = "[email protected]",
comment = c(ORCID = "0000-0001-5043-8033")
))
Description: Simplifies the execution of command line tools within isolated and
reproducible environments.
It enables users to effortlessly manage Conda environments,
execute command line tools, handle dependencies, and ensure reproducibility
in their data analysis workflows.
person("Claudio", "Zanettini", , "[email protected]", role = c("aut", "ctb"),
comment = c(ORCID = "0000-0001-5043-8033"))
)
Description: Simplifies the execution of command line tools within
isolated and reproducible environments. It enables users to
effortlessly manage Conda environments, execute command line tools,
handle dependencies, and ensure reproducibility in their data analysis
workflows.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
URL: https://github.com/luciorq/condathis
BugReports: https://github.com/luciorq/condathis/issues
Imports:
Expand All @@ -36,7 +27,10 @@ Imports:
utils,
withr
Suggests:
testthat (>= 3.0.0),
curl,
dplyr
dplyr,
testthat (>= 3.0.0)
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
1 change: 0 additions & 1 deletion condathis.Rproj
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Version: 1.0
ProjectId: 9ddf74f2-3627-4d31-97aa-6a6d7606c524

RestoreWorkspace: No
SaveWorkspace: No
Expand Down
5 changes: 5 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## R CMD check results

0 errors | 0 warnings | 1 note

* This is a new release.

0 comments on commit 46cc7d5

Please sign in to comment.