Skip to content

Latest commit

 

History

History
243 lines (201 loc) · 8.53 KB

CONTRIBUTING.md

File metadata and controls

243 lines (201 loc) · 8.53 KB
Raw

Contribute to OKplan

Thank you for considering contributing to OKplan.

OKplan is one of several packages assembled under the name NVIverse, a collection of R-packages with tools to facilitate data management and data reporting at the Norwegian Veterinary Institute (NVI).

NVIverse packages

Package Status Description
NVIconfig Private Configuration information necessary for some NVIverse functions
NVIdb Public Tools to facilitate the use of NVI’s databases
NVIpjsr Public Tools to facilitate working with PJS data
NVIspatial Public Tools to facilitate working with spatial data at NVI
NVIpretty Public Tools to make R-output pretty in accord with NVI’s graphical profile
NVIbatch Public Tools to facilitate the running of R-scripts in batch mode at NVI
OKplan Public Tools to facilitate the planning of surveillance programmes for the NFSA
OKcheck Public Tools to facilitate checking of data from national surveillance programmes
NVIcheckmate Public Extension of checkmate with argument checking adapted for NVIverse
NVIpackager Public Tools to facilitate the development of NVIverse packages
NVIrpackages Public Keeps a table of the R packages in NVIverse

How you can contribute

There are several ways you can contribute to this project: ask a question, propose an idea, report a bug, improve the documentation, or contribute code.

Ask a question

Using OKplan and need help? Browse the package help to see if you can find a solution. Still problems? Post your question in R-forum at workplace or contact the package maintainer by email.

Propose an idea

Have an idea for a new OKplan feature? Take a look at the OKplan help and issue list to see if it isn’t included or suggested yet. If not, suggest your idea as an issue on GitHub. While we can’t promise to implement your idea, it helps to:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible.

See below if you want to contribute code for your idea as well.

Report a bug

Using OKplan and discovered a bug? Don’t let others have the same experience and report it as an issue on GitHub so we can fix it. A good bug report makes it easier for us to do so, so please include:

  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Improve the documentation

Noticed a typo on the function help? Think a function could use a better example? Good documentation makes all the difference, so your help to improve it is very welcome!

Functions are described as comments near their code and translated to documentation using roxygen2. If you want to improve a function description:

  1. Go to R/ directory in the code repository.
  2. Look for the file with the name of the function.
  3. Propose a file change to update the function documentation in the roxygen comments (starting with #').

Contribute code

Care to fix bugs or implement new functionality for our_package? Great! Have a look at the issue list and leave a comment on the things you want to work on. See also the development guidelines below.

Development guidelines

If you want to contribute code, you are welcome to do so. You will find a description of the code conventions, which have been used, in the vignette “NVIverse code conventions” in the package NVIpackager. A summary of the principles and style convention used for NVIverse-packages is given below.

  • Please limit the number of package dependencies for OKplan. The use of base functions is much appreciated.

  • New code should generally follow the tidyverse style guide with some modifications.

    • use snake_case for variable names, column names, function names etc.
    • function names should start with a verb and should be descriptive and can be long. Avoid strange abbreviations.
    • to indent the code you may use the short cut keys Ctrl+a (select all) and Ctrl+i (indent) when you are in R-studio.
    • I recommend to use the styler package to apply spaces: styler::style_file(filename, scope = c("spaces", "line_breaks")). Please don’t restyle code that has nothing to do with your pull request.

  • You should add a bullet point to NEWS motivating the change.

  • You should add yourself as a contributor to the DESCRIPTION.

Although not expected from all contributors, it will be highly appreciated if you also are willing to suggest:

  • documentation for new functions or new arguments to existing functions The NVIverse-packages use roxygen2 for documentation.

  • argument checking of the function arguments. The NVIverse-packages use the assert-functions from the checkmate package for argument checking as well as some additional assert-functions in NVIcheckmate.

  • one or more tests ensuring that the function works as intended. The NVIverse-packages use testthat for tests.

Git commit standards

We follow the commit message style guide maintained within the angular.js project.

The start of commit messages should be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • doc: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug or adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Do not capitalize the first letter.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating to this project, you agree to abide by its terms.

References

This document is adapted from a template by @peterdesmet .