Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (60 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

94 lines (60 loc) · 3.41 KB

Contributing to Flip

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. This example question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Prerequisites

  • Node.js >=20
  • yarn - dependency management
  • eslint - enforcing standard lint rules
  • prettier - enforcing standard code formatting
  • jest - testing code

Quick Start

  1. Clone the repository to your local machine, for example using SSH:
git clone git@github.com:VictorS67/flip.git

or using HTTPS:

git clone https://github.com/VictorS67/flip.git
  1. cd into your the cloned folder and run the following command:
yarn install

Build Packages

TBA

Test

TBA

Lint & Format

We use ESLint for linting and Prettier for formatting. To run linting, run yarn lint in the root folder. This will run linting for all packages.

We also recommend enabling the Format on Save option in VS Code to automatically format files with Prettier on save. In addition, we use 2 spaces for indentation rather than tabs.

License

By contributing, you agree that your contributions will be licensed under its MIT License.