Merge pull request #1154 from appfolio/clean-up-docs-files

Clean up docs and files

README.md

@@ -7,15 +7,17 @@ and [reactstrap](https://reactstrap.github.io).
 https://appfolio.github.io/react-gears
 
 ----
-## Getting Started
 
-    yarn add @appfolio/react-gears
-    # or for npm:
-    npm install @appfolio/react-gears
+## Getting Started
+```
+yarn add @appfolio/react-gears
+# or for npm:
+npm install @appfolio/react-gears
+```
 
 ### Example
 
-```
+```js
 import React from 'react';
 import { Button } from '@appfolio/react-gears';
 
@@ -26,38 +28,86 @@ export default (props) => {
 };
 ```
 
-## Development
+### [Cypress](https://www.cypress.io) Testing
+
+You can use [react-gears-cypress](https://github.com/appfolio/react-gears-cypress) for testing react-gears components in your project.
 
-**IMPORTANT:** Make sure your commits follow [conventional commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/)!
+----
+
+## Development
 
 Install dependencies:
 
-    yarn install
+```
+yarn install
+```
 
 Run storybook examples:
 
-    yarn start
-
-Open [http://localhost:6006](http://localhost:6006) in browser
+```
+yarn start
+```
 
-Run tests & coverage report:
+Then open [http://localhost:6006](http://localhost:6006) in a browser.
 
-    yarn test
+Run tests:
 
-- Runs unit tests using [Mocha](https://mochajs.org/) and [enzyme](http://airbnb.io/enzyme/index.html)
+```
+yarn test
+```
 
-If using [Cypress](https://www.cypress.io) for integration testing, you can use [react-gears-cypress](https://github.com/appfolio/react-gears-cypress) for testing react-gears components.
+This runs unit tests using [Mocha](https://mochajs.org/) and [enzyme](http://airbnb.io/enzyme/index.html).
 
 Run Linter
 
-    yarn lint
+```
+yarn lint
+```
+
+This runs [ESLint](http://eslint.org/) using [appfolio-react](https://github.com/appfolio/eslint-config-appfolio-react) as the base configuration.
+
+----
+
+## Contributing
+
+### Commit messages
+
+Commit messages should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format:
+
+```
+<type>(<scope>): <message>
+```
+
+Here's an example commit message:
+
+```
+feat(SomeComponent): add new thing that does something
+```
+
+- `<scope>` is optional.
+- `!` indicates a breaking change. Example: `feat!: some breaking change`.
+
+Here are a few common `<type>`s:
+
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation changes
+- `refactor`: Code changes that neither fix a bug nor add a feature
+- `test`: Adding missing tests or correcting existing tests
+- `ci`: Changes to CI configuration files and scripts
+- `chore`: Other changes that don't modify src or test files
+
+For more information about Conventional Commits, see the [official documentation](https://www.conventionalcommits.org/en/v1.0.0/).
+
+### Merging changes
 
-- Runs [ESLint](http://eslint.org/) using [appfolio-react](https://github.com/appfolio/eslint-config-appfolio-react) as the base configuration
+Open a pull request, get it approved by the relevant code owners, and merge your pull request.
 
-## Publishing
+**IMPORTANT**: Make sure your pull request is NOT squash merged. The merge button has dropdown options. Choose "Create a merge commit" or "Rebase and merge".
 
-Release PRs are automatically generated by [release-please](https://github.com/googleapis/release-please) when new commits are merged to `master`. When you're ready to publish, just merge the release PR (branch should look like `release-v${major}.${minor}.${patch}`).
+### Creating a release
 
-## Publishing pre-releases
+Any pull request against the default branch will cause a prerelease to be created. This prerelease can be used to test your branch.
 
-Open a PR and a comment will be added to the PR notifying a pre-release was created after a few minutes.
+[release-please](https://github.com/googleapis/release-please) will automatically create or update a "release pull request" with the changes you made.
+Merge this "release pull request" to release an official new version.

docs/iframe.html

@@ -363,4 +363,4 @@
 
 
 
-            window['STORIES'] = [{"titlePrefix":"","directory":"./.storybook/stories","files":"Welcome.stories.js","importPathMatcher":"^\\.[\\\\/](?:\\.storybook\\/stories\\/Welcome\\.stories\\.js)$"},{"titlePrefix":"","directory":"./src","files":"**/*.stories.{js,tsx}","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.(js|tsx))$"},{"titlePrefix":"","directory":"./.storybook/stories","files":"More.stories.js","importPathMatcher":"^\\.[\\\\/](?:\\.storybook\\/stories\\/More\\.stories\\.js)$"}];</script><script src="runtime~main.6ca527da.iframe.bundle.js"></script><script src="vendors~main.e4bc2071.iframe.bundle.js"></script><script src="main.ba988520.iframe.bundle.js"></script></body></html>
+            window['STORIES'] = [{"titlePrefix":"","directory":"./.storybook/stories","files":"Welcome.stories.js","importPathMatcher":"^\\.[\\\\/](?:\\.storybook\\/stories\\/Welcome\\.stories\\.js)$"},{"titlePrefix":"","directory":"./src","files":"**/*.stories.{js,tsx}","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.(js|tsx))$"},{"titlePrefix":"","directory":"./.storybook/stories","files":"More.stories.js","importPathMatcher":"^\\.[\\\\/](?:\\.storybook\\/stories\\/More\\.stories\\.js)$"}];</script><script src="runtime~main.6ca527da.iframe.bundle.js"></script><script src="vendors~main.64050e5a.iframe.bundle.js"></script><script src="main.c81b7554.iframe.bundle.js"></script></body></html>

docs/index.html

@@ -56,4 +56,4 @@
 
 
 
-            window['DOCS_MODE'] = false;</script><script src="runtime~main.7f90b8da84111ec270f3.manager.bundle.js"></script><script src="vendors~main.b8e3574f587b20406b8e.manager.bundle.js"></script><script src="main.b476db9d634e6cb7a18c.manager.bundle.js"></script></body></html>
+            window['DOCS_MODE'] = false;</script><script src="runtime~main.7f90b8da84111ec270f3.manager.bundle.js"></script><script src="vendors~main.b8e3574f587b20406b8e.manager.bundle.js"></script><script src="main.aaabcbbe9d6dc4bc95fa.manager.bundle.js"></script></body></html>

docs/project.json

@@ -1 +1 @@
-{"generatedAt":1682617320828,"builder":{"name":"webpack4"},"hasCustomBabel":false,"hasCustomWebpack":false,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"yarn","version":"3.2.2"},"storybookVersion":"6.5.10","language":"typescript","storybookPackages":{"@storybook/addon-links":{"version":"6.5.10"},"@storybook/addons":{"version":"6.5.10"},"@storybook/react":{"version":"6.5.10"}},"framework":{"name":"react"},"addons":{"@storybook/addon-essentials":{"options":{"backgrounds":false,"controls":false,"docs":false},"version":"6.5.10"},"@storybook/addon-knobs":{"version":"6.4.0"},"@storybook/addon-actions":{"version":"6.5.10"},"@storybook/addon-storysource":{"options":{"rule":{"enforce":"pre"}},"version":"6.5.10"},"@storybook/addon-viewport":{"version":"6.5.10"},"@storybook/addon-a11y":{"options":{"element":"#story-root"},"version":"6.5.10"}}}
+{"generatedAt":1682641118199,"builder":{"name":"webpack4"},"hasCustomBabel":false,"hasCustomWebpack":false,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"yarn","version":"3.2.2"},"storybookVersion":"6.5.10","language":"typescript","storybookPackages":{"@storybook/addon-links":{"version":"6.5.10"},"@storybook/addons":{"version":"6.5.10"},"@storybook/react":{"version":"6.5.10"}},"framework":{"name":"react"},"addons":{"@storybook/addon-essentials":{"options":{"backgrounds":false,"controls":false,"docs":false},"version":"6.5.10"},"@storybook/addon-knobs":{"version":"6.4.0"},"@storybook/addon-actions":{"version":"6.5.10"},"@storybook/addon-storysource":{"options":{"rule":{"enforce":"pre"}},"version":"6.5.10"},"@storybook/addon-viewport":{"version":"6.5.10"},"@storybook/addon-a11y":{"options":{"element":"#story-root"},"version":"6.5.10"}}}

package.json

@@ -28,7 +28,6 @@
     "test": "jest --coverage",
     "test:watch": "jest --watch",
     "start": "start-storybook -p 6006",
-    "build-storybook": "build-storybook",
     "docs": "build-storybook -o docs",
     "version": "yarn docs && git add -A docs",
     "clean": "rm -rf esm lib",