Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.84 KB
Raw

Contributing

We welcome contributions to immunedeconv!

Filing an issue

Bug reports and feature requests are indispensible for improving immunedeconv. To make them as useful as possible:

  • Search the repository to see if someone has already reported the same issue. This allows contributors to spend less time responding to issues, and more time adding new features!
  • Please provide a minimal complete verifiable example for any bug. If you're not sure what this means, check out this blog post by Matthew Rocklin or this definition from StackOverflow.
  • Let us know about your environment. Environment information is available via sessionInfo().

Contributing code

We are absolutely enthusiastic about code contributions! If you prepare a PR, we'd like you to follow the following guidelines:

Tests

Please write tests! We use testthat to ensure the package works correctly. You can refer to the existing test suite and the Testing chapter from the R packages book when adding new tests.

Documentation

When adding a new function, make sure you write appropriate documentation. We make use of roxygen2 to document functions and pkgdown to render the documentation website.

  • The roxygen2 docstring should describe what the function is doing (try to think about it from the prespective of the user).
  • The docstring should describe all parameters and return values.
  • Consider adding an example to one of the vignettes.