Skip to content

Files

Latest commit

jdornjdorn
Generate Jupyter notebook of experiment results (growthbook#81)
Sep 20, 2021
27d5413 · Sep 20, 2021

History

History
108 lines (67 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

108 lines (67 loc) · 4.21 KB

Contributing Guide

Interested in making GrowthBook better? So are we! This guide should help get you setup with a local development environment so you can make changes, create PRs, and get your code merged.

If you just want to contribute a client library in a new language and not make changes to the app itself, you can skip the instructions here and view https://docs.growthbook.io/lib/build-your-own instead.

Requirements

  • MacOS or Linux (Windows may work too, but we haven't tested it)
  • NodeJS 12.x or 14.x
  • Yarn
  • Python 3.6+ (for the stats engine)
  • Docker (for running MongoDB locally)

Getting started

  1. Fork the project
  2. Clone your forked project by running git clone [email protected]:{ YOUR_USERNAME }/growthbook.git
  3. Run yarn to install node modules
  4. Start MongoDB in Docker
docker run -d -p 27017:27017 --name mongo \
  -e MONGO_INITDB_ROOT_USERNAME=root \
  -e MONGO_INITDB_ROOT_PASSWORD=password \
  mongo
  1. Run yarn dev to start the app in dev mode
  2. Visit http://localhost:3000 in your browser and verify the app is working correctly

Changing Configuration Settings

If you need to change any of the default configuration settings, you can use environment variables:

  • Back-end: cp packages/back-end/.env.example packages/back-end/.env.local
  • Front-end: cp packages/front-end/.env.example packages/front-end/.env.local

Then, edit the .env.local files as needed.

Writing code!

This repository is a monorepo with the following packages:

  • packages/front-end is a Next.js app and contains the full UI of the GrowthBook app.
  • packages/back-end is an Express app and serves as the REST api for the front-end.
  • packages/docs is another Next.js app of our documentation site (https://docs.growthbook.io).
  • packages/sdk-js is our javascript SDK (@growthbook/growthbook on npm)
  • packages/sdk-react is our React SDK (@growthbook/growthbook-react on npm)
  • packages/sdk-dev is a Dev Mode variation switcher for our SDKs (@growthbook/dev on npm)
  • packages/stats is our Python stats engine (gbstats on PyPi)

Depending on what you're changing, you may need to edit one or more of these packages.

Working on the main app

The yarn dev command starts both the front-end and back-end in parallel

The packages are available at the following urls with hot-reloading:

Working on docs

To start the docs site, run yarn workspace docs dev. You can view the site at http://localhost:3200

Working on the SDKs

Build the javascript SDK with yarn workspace @growthbook/growthbook build

Build the react SDK with yarn workspace @growthbook/growthbook-react build

The SDK dev mode has a playground for development. Make sure to build the javascript SDK and react SDK first before running. Start the playground with yarn workspace @growthbook/dev dev and view at http://localhost:3300

Working on the stats engine

We use poetry for managing dependencies. In the packages/stats directory, run poetry install.

You may need to install some dependencies manually if you are using conda:

conda install scipy numpy pandas

Then you can run the test suite with pytest.

Code Quality

Run repo-wide test suites with yarn test

There is a pre-commit hook that lints the code base and performs Typescript type checking. This can take 30 seconds or more so please be patient. You can run these same checks yourself with yarn lint and yarn type-check.

Python

You can lint the python stats engine manually with yarn workspace stats lint. Note: you may need to install some global python dependencies with pip install flake8 black.

Opening Pull Requests

  1. Please Provide a thoughtful commit message and push your changes to your fork using git push origin main (assuming your forked project is using origin for the remote name and you are on the main branch).

  2. Open a Pull Request on GitHub with a description of your changes.

Getting Help

Join our Slack community if you need help getting set up or want to chat. We're also happy to hop on a call and do some pair programming.