Contributing to gofcat

Project Status: Active – The project has reached a stable, usable state and is being activelydeveloped license R build status Codecov test coverage

Thank you for taking the time to contribute to the development of gofcat. You could find the following guidelines useful in making your contributions.

Before you start:

  • It is important to have a valid GitHub account.
  • Trivial changes to comments or documentation do not require creating a new issue.

Did you find a bug?

  • Make sure the bug was not already reported in the Github Issues.
  • Open an issue and clearly describe the issue with as much information as possible. A code sample or an executable test case are recommended.

Did you plan to write a patch that fixes a bug?

  • Open an issue and clearly describes the problem and discuss how your solution will affect gofcat.
  • Fork the repository on GitHub to work on the patch.
  • Get in touch with the maintainer to refine and prioritize your issue.

Making changes and Pull requests

  • Start your work on your fork of the repository. If you haven’t done this before, try using usethis::create_from_github("ejikeugba/gofcat", fork = TRUE).
  • Install all development dependences with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check().
  • Create a Git branch for your pull request (PR). You may want to use usethis::pr_init("brief-description-of-change").
  • Check for unnecessary whitespace with git diff --check and format code.
  • Commit messages should be descriptive, mentioning what was changed and why, and also reference the relevant issue number.
  • Ensure to add the necessary tests for your changes (testthat preferably).
  • Run all the tests to assure nothing else was accidentally broken, also keep an eye on the test coverage metric.
  • Commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser
  • On submission, it is crucial your PR includes the following statement: You own the copyright on the code being contributed, and you hereby grant gofcat repo cph unlimited license to use this code in this version or any future version of gofcat. You reserve all other rights to the code.
  • It may not be advisable to contribute third party codes to this project. Useful suggestions are nonetheless welcomed.
  • The Pull Requests are thereafter reviewed, with feedbacks communicated as soon as possible.

Code of Conduct

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

Additional Resources