Issues and Pull Requests

If you are considering a pull request, you may want to open an issue first to discuss with the maintainer(s).

Code contributions

  • Fork this repo to your GitHub account
  • Clone your version on your account down to your machine from your account, e.g,. git clone https://github.com/<yourgithubusername>/fauxpas.git
  • Make sure to track progress upstream (i.e., on our version of fauxpas at sckott/fauxpas) by doing git remote add upstream https://github.com/sckott/fauxpas.git. Before making changes make sure to pull changes in from upstream by doing either git fetch upstream then merge later or git pull upstream to fetch and merge in one step
  • Make your changes (bonus points for making changes on a new feature branch - see https://guides.github.com/introduction/flow/ for how to contribute by branching, making changes, then submitting a pull request)
  • Push up to your account
  • Submit a pull request to home base (likely main branch, but check to make sure) at sckott/fauxpas

Thanks for contributing!