Skip to content

Latest commit

 

History

History
67 lines (36 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

67 lines (36 loc) · 2.48 KB
Raw

Quadratic Contribution Guide

Thank you for considering contributing to the data science spreadsheet ✨

Read our Code of Conduct to keep our community approachable and respectable.

In this guide, you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

Make sure you can run Quadratic locally from the source.

Install Dependencies npm install

Run Web npm start

Run Electron npm run dev

If you have any problems getting the project to run locally, please create an issue to document the problem. See "Create an issue" below.

Issues for Feature Requests and Bugs

Quadratic uses GitHub issues to track all feature requests and bugs.

Create an issue

If you have a feature request or spot a problem, search if an issue already exists. If a related issue does not exist, please open a new issue!

When reporting a bug, please provide:

  • Issue description
  • Steps to reproduce the issue
  • What's the expected result?
  • What's the actual result?
  • Additional details / screenshots

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.

How to contribute code

  1. Fork the repository.

  2. Run Quadratic locally. See "Getting Started" above.

  3. Create a new working branch and start making your changes!

  4. Lint and format your changes using Prettier.

Pull Request

When you're finished with your changes:

  1. Create a pull request.

  2. Link your PR to the GitHub Issue link PR to issue if you are working on an Issue.

  3. Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.

We review all PRs quickly, so we will give you feedback in short order!

Your PR is merged!

Congratulations 🎉🎉 Quadratic is better because of you ✨.

Once your PR is merged, contributors will be publicly visible on the GitHub Page.