Contributing

Table of Contents

  1. Contribute to the software

  2. Report issues of problems with the software

  3. Seek support

  4. Community guidelines

Contribute

Getting Started

  1. Start by forking the main repository

  2. Clone your copy of the repository.

    • Using ssh:

    git clone git@github.com:[your user name]/offlinedatasci.git

    • Using https:

    git clone https://github.com/[your user name]/offlinedatasci.git

  3. Link or point your cloned copy to the main repository. (I always name it upstream)

    git remote add upstream https://github.com/carpentriesoffline/offlinedatasci.git

  4. Check or confirm your settings using git remote -v

    origin git@github.com:[your user name]/offlinedatasci.git (fetch)
origin git@github.com:[your user name]/offlinedatasci.git (push)
upstream https://github.com/carpentriesoffline/offlinedatasci.git (fetch)
upstream https://github.com/carpentriesoffline/offlinedatasci.git (push)

  5. Install the package from the main directory.

offlinedatasci can be installed from source using including pip or uv.

Install using Pip

pip install .'[dev,docs]'

Install using uv

uv sync --all-extras --dev

Installing R

Code of setting up the CRAN mirror (packages or R) requires requires that R be installed on the system. If R is not already installed follow the installation instructions for your operating system

We use the miniCRAN package to handle mirroring CRAN. It will be automatically installed if it is not already or if the minimum version is too low.

Running tests locally

pytest -v

Reporting Issues

  • To report issues or problems with either the material or the operation of the site please open an issue and we’ll be happy to address it.

Getting Help

Community Guidelines

See our Code of Conduct for our community guidelines.