Skip to content

Latest commit

 

History

History
69 lines (54 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

69 lines (54 loc) · 3.36 KB
Raw

Contributing

Thanks for taking the time to contribute! 🎉 🎊 👍

Getting started

Looking for places to contribute to the codebase? Check out the Status: accepting PRs label.

Installation

First, ensure you have Node v8+ and yarn v1.0+ installed on your machine.

As an external contributor (not a member of the Palantir org), you will have to fork Blueprint in order to contribute code. Clone your fork onto your machine and run the following commands to install dependencies:

git clone git@github.com:<username>/blueprint.git # using ssh
cd blueprint
yarn

Developing

A typical contributor workflow looks like this:

  1. Create a new feature branch. We use a format like [your-initials]/[short-name]: bd/refactor-buttons.
  2. Run the development script for the relevant part of the project (see README for the full list).
    • webpack-dev-server will automatically launch a browser window where you can iterate on changes.
  3. Write some code. 🔨 Refer to the wiki in this repo for detailed instructions on:
  4. Ensure your code is tested and linted.
    • Add unit tests as necessary when fixing bugs or adding features; run them with yarn test in the relevant package folder.
    • Linting is best handled by your editor for real-time feedback (see Editor integration). Run yarn lint to be 100% safe.
    • Lint errors can often be automatically fixed by TSLint. Run lint fixes with yarn lint-fix.
  5. Submit a Pull Request on GitHub.
    • Write a thorough description of your work so that reviewers and future developers can understand your code changes.
  6. Team members will review your code and merge it after approvals.
    • You may be asked to make modifications to code style or to fix bugs you may have not noticed.
    • Please respond to comments in a timely fashion (even if to tell us you need more time).
  7. Hooray, you contributed! 🎩

Enable preview comments

The team relies on PR "preview comments" for immediate feedback on features during development. Forkers must manually enable comments by defining the GH_AUTH_TOKEN environment variable on CircleCI.

If you're developing on a fork of Blueprint:

  1. Navigate to CircleCI, log in using your GitHub account, and click "Build project" for your fork of Blueprint.

  2. Navigate to the token settings on GitHub and create a user token with the public_repo scope.

  3. Navigate to your CircleCI repo settings: https://circleci.com/gh/<username>/blueprint/edit#env-vars and create a new environment variable called GH_AUTH_TOKEN with the token you created earlier. The end result should look like so:

    image

  4. When a build passes, a comment will be automatically posted to your PR that links to the generated artifacts containing your changes.