From 5a9f287fae1c35e9df618c8e022d12b19bfc562e Mon Sep 17 00:00:00 2001 From: Gilad Gray Date: Wed, 5 Dec 2018 15:44:57 -0800 Subject: [PATCH 1/2] update contributing notes: DO NOT enable Circle for forks. --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++------- CONTRIBUTING.md | 22 +++------------------- 2 files changed, 9 insertions(+), 26 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 68d526da61..5c54ee8c87 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,20 @@ #### Fixes #0000 #### Checklist - -- [ ] [Enable CircleCI for your fork](https://circleci.com/add-projects) -- [ ] [Enable preview comments on CircleCI](https://github.com/palantir/blueprint/blob/develop/CONTRIBUTING.md#enable-preview-comments) -- [ ] Include tests +- [ ] Includes tests - [ ] Update documentation + + #### Changes proposed in this pull request: - + #### Reviewers should focus on: - + #### Screenshot - + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8e3e2f807..dd5b8e2316 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,28 +41,12 @@ A typical contributor workflow looks like this: `yarn lint` to be 100% safe. - TypeScript lint errors can often be automatically fixed by TSLint. Run lint fixes with `yarn lint-fix`. 1. Submit a Pull Request on GitHub and fill out the template. + - :warning: __DO NOT enable CircleCI for your fork of Blueprint.__ Our build + will run on your fork when you open a PR. You can run relevant parts of + the build locally by inspecting the config or 1. 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). - _Do not_ amend commits and `push --force` as they break the PR history. Please add more commits; we squash each PR to a single commit on merge. 1. Hooray, you contributed! :tophat: -### 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](https://circleci.com/add-projects), log in using your GitHub account, -and click **"Build project"** for your fork of Blueprint. -1. Navigate to the [token settings](https://github.com/settings/tokens) on GitHub and create a user -token with the `public_repo` scope. -1. Navigate to your CircleCI repo settings: `https://circleci.com/gh//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](https://cloud.githubusercontent.com/assets/464822/22609529/6845d7e6-ea16-11e6-8a8e-444057bc4687.png) -1. When a build passes, a comment will be automatically posted to your PR that links to the -generated artifacts containing your changes. From 51d74114a5144aabdade6ef7e459cfb6072411bf Mon Sep 17 00:00:00 2001 From: Gilad Gray Date: Wed, 5 Dec 2018 16:09:22 -0800 Subject: [PATCH 2/2] finish the sentence --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd5b8e2316..3d17f74474 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,9 @@ A typical contributor workflow looks like this: `yarn lint` to be 100% safe. - TypeScript lint errors can often be automatically fixed by TSLint. Run lint fixes with `yarn lint-fix`. 1. Submit a Pull Request on GitHub and fill out the template. - - :warning: __DO NOT enable CircleCI for your fork of Blueprint.__ Our build - will run on your fork when you open a PR. You can run relevant parts of - the build locally by inspecting the config or + - ⚠️ __DO NOT enable CircleCI for your fork of Blueprint.__ Our build + will run on your fork when you open a PR. You can run NPM scripts locally + to validate before pushing code. 1. 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).