Skip to contents

Contributing to FactoMineR2

Source: .github/CONTRIBUTING.md

This outlines how to propose a change to FactoMineR2.

Fixing typos

Small typos or grammatical errors in documentation CANNOT be edited directly using the GitHub web interface. Please, all changes were made with commit and pull request.

Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal example.

Reports bugs

Report bugs at https://github.com/alexym1/FactoMineR2/issues.

Contribution

    1. Clone the repo
    git clone git@github.com:alexym1/FactoMineR2.git
    1. Create a branch for latest master or main branch.
    1. Set up reproducible environment using renv::restore() package.
    1. Check that your changes, please add unit tests
    # Run this command to validate your tests
testthat::test_dir("tests/testthat")
    1. Check the coverage. The coverage should be at least 90%.
    detach("package:FactoMineR2", unload=TRUE)
covr::package_coverage()
    1. Run devtools::check() to ensure that your code meets the package’s standards. Fix errors, warnings or notes that may appear.
    1. (optional) New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.
    1. Push to remote source:
    git push origin <your_branch_name>

Pull request

    1. Check unit tests and package’s standards (see Contribution)
    1. For user-facing changes, add a bullet to the top of NEWS.md below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).
    # Update the existing NEWS.md file
pkgdown::build_site()
    1. Create a pull request to <your_branch_name> to master or main.
    1. Copy/Paste the latest bullet of NEWS.md in the PR description.
    1. Bump to version the following files:
    • Description
    • NEWS.md
    • README.Rmd

The version number should be in the format x.y.z. If the change is a bug fix, update z. If the change is an enhancement, update y. If the change is a breaking change, update x.

    1. Confirm PR and remove merged branch.

CI files will check code coverage and update website.

Code of Conduct

By participating in this project you agree to abide by its terms.