Skip to contents

Contributing to our Package

Source: CONTRIBUTING.md

First of all, we thank you for any and all contributions to this project! 🎉

Table of Contents

What Should I Know Before I Get Started?

We appreciate suggestions to improve the code and resolve bug fixes, but please be respectful and follow the Code of Conduct.

How to Contribute

For Core Members

This applies to the following core members of our group: Heidi Lantz, Nazia Edroos, Jessica Luo, and Jade Chen.

If you notice a bug, or have a feature request, please open up an issue here.

If you’d like to contribute a feature or bug fix, you should work in the standard GitHub workflow by creating a branch from the main project repo. Once you are satisfied with your changes, you can open a pull request (PR), and get another core member to review your changes.

We will review pull requests within 7 days.

For Others

If you notice a bug, or have a feature request, please open up an issue here.

If you’d like to contribute a feature or bug fix, follow these steps:

How to contribute 1. On your GitHub account, fork the package repository.

  1. Clone your fork of the repository to your local machine using a Command Line Interface tool. bash git clone https://github.com/PATH-TO-YOUR-FORKED-REPOSITORY

  2. Navigate to the directory containing the R package on your machine.

  3. Install the dependencies listed in DESCRIPTION. bash Rscript -e 'devtools::install_deps()'

  4. Once your local environment is up-to-date, you can create a new git branch which will contain your contribution (always create a new branch instead of making changes to the main branch): bash git switch -c <your-branch-name>

  5. Start contributing!

Making a Pull Request 1. Ensure your code runs correctly and is well documented. 2. Create a pull request. bash git add <modified-file> git commit -m "a descriptive message about your change" git push origin <your-branch-name> 3. Someone from our team will review your changes and decide whether to add this to the main code. - We will review pull requests within 7 days. - Please make sure to thoroughly explain the fixes you made in the description of the PR, so that when a core member reviews it they fully understand what changes you made.

Style Guide

  • Code:
  • Naming Conventions:
    • Variable names are a balance of short and interpretable, each new word is separated by _. For example: alcohol_use.
  • Git Commits:
    • Limit the first line to 72 characters or less
    • Reference issues and pull requests liberally after the first line
    • Include thoughtfully-worded, well-structured descriptions.
  • Documentation:

Code of Conduct

All contributors must abide by our code of conduct. By contributing to this project you agree to abide by its terms.

Attribution

These contributing guidelines were adapted from the altair contributing guidelines.