alihan/growthbook
1
0
Fork 0
mirror of https://github.com/growthbook/growthbook.git synced 2021-08-07 14:23:53 +03:00
Code Issues Projects Releases Wiki Activity
Files
main
growthbook/CONTRIBUTING.md
Jeremy Dorn 150626e417 Update docs. 
-  Update js docs to v0.11.0
-  Update react docs to v0.4.0
-  Add new 'build-your-own' client library docs page
-  Update in-app instructions for js/react to match latest versions
-  Fix url regex escaping bug in inline-script code
2021-06-11 13:11:13 -05:00

2.9 KiB
Raw Permalink Blame History

Contributing Guide

Interested in making Growth Book 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
  • Docker (for running MongoDB locally)

Getting started

  1. Fork the project
  2. Clone your forked project by running git clone git@github.com:{ 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 3 packages: front-end, back-end, and docs. All are using Typescript.

  • packages/front-end is a Next.js app and contains the full UI of the Growth Book 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).

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

The yarn dev command starts both the front-end and back-end in parallel. To start the docs site, run yarn workspace docs dev.

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

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.

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.