Welcome to Group 20's contribution file! This document outlines how to make contributions to the project. Contributions ranging from small typos to bug fixes to new code are welcome as long as the following guidelines are met. If in doubt, create a new issue for discussion or reach out one of the members of the development team.
Small typos or grammatical errors in documentation may be edited directly on GitHub as long as the changes are made to the source file.
If you are looking to contribute to this project, the best place to start is the GitHub "issues" tab. This is also a great place for filing bug reports and making suggestions for ways in which we can improve the code and documentation.
Prior to making a substantial pull request, please create a GitHub issue and make sure that a member of the existing team supports the need to fix the issue.
Once the green light is given by the team, please follow this pull request process:
- Fork the project repo to your own GitHub repo.
- Create a Git branch for each separate pull request (PR).
- Follow code and documentation style requirements outlined below.
- Include test cases and useful warning messages in code when appropriate.
- After double checking final product, push changes to your Github repo and create PR to main project repo. Wait for member of team to review and accept your PR (do not approve your own PR).
As much as possible, use the following accepted code styling guidelines. Avoid styling code that does not belong to your own PR.
- For R code, please follow the tidyverse style guide.
- For Python code, please follow the Black style guide.
- For documentation please follow the roxygen2/markdown format guide.
We aim to create a fun and inclusive project environment, please read and adhere to the Code of Conduct at all times.
The contributing.md file for this project uses content from the Pandas Github contributing file and dplyr Github contributing file.