minor edits to docs

This commit is contained in:
Tim Layton
2018-10-23 11:31:23 -07:00
parent c05580c217
commit 0d33f0e678
3 changed files with 9 additions and 7 deletions

View File

@@ -47,13 +47,13 @@ Otherwise, [request a feature](https://github.com/Shopify/polaris-react/issues/n
If you intend to build a new component, change a public API, make design improvements, or any other non-trivial changes, [we recommend filing an issue](https://github.com/Shopify/polaris-react/issues/new?template=FEATURE_REQUEST.md). This lets us all discuss and reach an agreement on the proposal before you put in significant time and effort.
Please use [this template for proposing new components or changes to existing components](https://github.com/Shopify/polaris-react/issues/new?template=NEW_COMPONENT.md).
Please use this [template for proposing new components or changes to existing components](https://github.com/Shopify/polaris-react/issues/new?template=NEW_COMPONENT.md).
If youre only fixing a bug, its okay to submit a pull request right away but we still recommend you file an issue detailing what youre fixing. This is helpful in case we dont accept that specific fix but want to keep track of the issue.
## Your first pull request
Working on your first Pull Request? You can learn how from this free video series:
Working on your first pull request? You can learn how from this free video series:
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
@@ -102,7 +102,7 @@ After cloning Polaris React, run `yarn` to fetch its dependencies. Then you can
- `yarn test <pattern>` runs tests with matching filenames
- `yarn tophat` runs a local development server and mounts all of the component examples
We recommend running `yarn test` (or its variations above) to make sure you dont introduce any regressions as you work on your change. However it can be handy to try your build of Polaris React in a real project.
We recommend running `yarn test` (or its variations above), as well as trying your build of Polaris React in a real project, to make sure you dont introduce any regressions as you work on your change.
Run `yarn run build-consumer <project>` where `<project>` is the directory the build will be copied. **The `<project>` directory must be a sibling of the `polaris-react` directory**.

View File

@@ -176,5 +176,5 @@ Percy is a tool thats supposed to help you and give you more confidence, not
```
Where `aaaabbbbcccc` is the API key available in the
[Percy project settings page for polaris-react](https://percy.io/Shopify/polaris-react/settings).
3. Check tests results: <https://percy.io/Shopify/polaris-react> (cant
3. Check tests results: <https://percy.io/Shopify/polaris-react> (Cant
view the results? [Ask for access on Slack](https://shopify.slack.com/messages/C4Y8N30KD))

View File

@@ -1,6 +1,8 @@
# Tophatting 🎩
TL;DR This is a collection of lessons learned from breaking things. Its not enough to rely on automated tests.
## Summary
This is a collection of lessons learned from breaking things. Its not enough to rely on automated tests.
As you make changes, non-obvious things can break. Manual testing (we call it “tophatting”, or 🎩 for short) adds that extra degree of certainty that what youre shipping works and behaves as expected. Both you, as the author of a PR, and someone on your team, should 🎩 before merging.
@@ -30,7 +32,7 @@ Spending the extra time to provide clear instructions saves everybody time, and
- Be explicit about the scope of your changes so that unrelated bugs dont block the PR
- Be explicit about your own 🎩, and any areas or interactions you might be unsure about
- Include a screenshot of the expected result of a successful 🎩
- Be grateful (e.g. “Thanks for catching that!”) reviewers are taking time out of their day to help you and thats a special kind of gift
- Be grateful (for example, “Thanks for catching that!”) reviewers are taking time out of their day to help you and thats a special kind of gift
## Approach to tophatting someones PR
@@ -39,7 +41,7 @@ Giving someone a thorough 🎩 builds trust and trains your attention to detail.
- Make sure you understand the scope and purpose of the authors PR if not, dont hesitate to ask the author to clarify
- Consider any areas the authors change may break, and test those
- Detail what steps you took for 🎩 and your findings
- Remember that unrelated bugs are better done in a separate PR Dont block something unless its necessary
- Remember that unrelated bugs are better done in a separate PR. Dont block something unless its necessary
- Include a screenshot with any issues that arise
## Cross browser testing