Contributing to iArt

We welcome contributions to the iArt project! Whether you’re interested in fixing bugs, adding new features, or improving documentation, your help is appreciated. This document provides guidelines and instructions for contributing to iArt.

Getting Started

Before you begin contributing to iArt, you should have:

  • A GitHub account

  • A basic understanding of version control with Git

  • Familiarity with Python or R programming

Setting Up Your Development Environment

  1. Fork the Repository: Start by forking the iArt repository on GitHub.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/Imputation-Assisted-Randomization-Tests/python-iArt.git # python version
or
git clone https://github.com/Imputation-Assisted-Randomization-Tests/iArt.git # R version
cd iArt

  3. Create a Virtual Environment for Python package (Optional but recommended):

    python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

  4. Install Development Dependencies:

    python setup.py install # Install local python version
or
devtools::install("/path/to/iArt") # Install local R version

Making Changes

  1. Create a New Branch:

    git checkout -b your-new-feature

  2. Make Your Changes: Add your changes to the codebase, making sure to adhere to the existing coding style.

  3. Test Your Changes: Run existing tests and add new ones if necessary.

Submitting Your Contribution

  1. Commit Your Changes:

    git add .
git commit -m "Add a brief description of your changes"

  2. Push to Your Fork:

    git push origin your-new-feature

  3. Create a Pull Request: Go to the original iArt repository on GitHub and create a pull request from your forked repository.

Contributor Code of Conduct

The iArt project adheres to a code of conduct that all contributors are expected to follow. This ensures a welcoming and inclusive environment for everyone.

Reporting Issues

If you find bugs or have suggestions for improvements, please create an issue on the GitHub repository. Be sure to include as much information as possible, such as:

  • The version of iArt you’re using

  • Steps to reproduce the issue

  • Expected and actual outcomes

Thank you for considering contributing to iArt!