Skip to content

Latest commit

 

History

History
11 lines (8 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

11 lines (8 loc) · 1.23 KB

autographs Contributor's Guide

So glad that you decided to contribute to this project! It's ongoing, and a lot of people need to use the things included here, so it's important that we leave behind a readable, well-kept codebase.

Setup

Before editing any code, make sure to run make setup. This will install the necessary packages as well as set up a global symlink to develop the package. For more info about this process, take a look at makefile.

Style

This project abides by the PEP8 and PEP257 style guides. Please read these before contributing, as it's integral to the maintainability of this project that these standards are upheld.

Pushing Code

We'll be using the same contribution model as RunDMCMC, wherein each contributing user has a fork of this repository and pushes changes to that fork. Then, when the user wants to make their code a part of the main repository, they open a pull request and await approval of others (please request reviewers!). Otherwise, follow this guide.