From c87164714358d7edfbfeac0a42bc392977732827 Mon Sep 17 00:00:00 2001 From: Josh Black Date: Tue, 14 May 2019 12:07:30 -0500 Subject: [PATCH] chore(project): update README and templates (#2368) --- .github/ISSUE_TEMPLATE.md | 44 +--------- .../ISSUE_TEMPLATE/accessibility-issue--.md | 48 ----------- .github/ISSUE_TEMPLATE/bug-report.md | 42 ---------- .../feature-request-or-enhancement---.md | 43 ---------- .github/ISSUE_TEMPLATE/question.md | 31 ------- .github/PULL_REQUEST_TEMPLATE.md | 21 ++--- README.md | 80 ++----------------- 7 files changed, 13 insertions(+), 296 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/accessibility-issue--.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request-or-enhancement---.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a967a7b3d8..f18d30c07d 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,44 +1,6 @@ - - -## Detailed description - -> Describe in detail the issue you're having. - -> Is this a feature request (new component, new icon), a bug, or a general issue? - -> Is this issue related to a specific component? - -> What did you expect to happen? What happened instead? What would you like to see changed? - -> What browser are you working in? - -> What version of the Carbon Design System are you using? - -> What offering/product do you work on? Any pressing ship or release dates we should be aware of? - -## Steps to reproduce the issue - - - - -1. Step one -2. Step two -3. Step three -4. etc. - -## Additional information - -- Screenshots or code -- Notes diff --git a/.github/ISSUE_TEMPLATE/accessibility-issue--.md b/.github/ISSUE_TEMPLATE/accessibility-issue--.md deleted file mode 100644 index 02db285a51..0000000000 --- a/.github/ISSUE_TEMPLATE/accessibility-issue--.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: Accessibility Issue β™Ώ -about: Report an accessibility or usability issue -title: '' -labels: 'type: a11y β™Ώ' -assignees: '' ---- - - - -## Environment - -> Operating system - -> Browser - -> Automated testing tool and ruleset - -> Assistive technology used to verify - -## Detailed description - -> What version of the Carbon Design System are you using? - -> What did you expect to happen? - -> What happened instead? - -> What WCAG 2.1 checkpoint does the issue violate? - -## Steps to reproduce the issue - -1. Step one -2. Step two -3. Step three -4. etc. - -> Please create a reduced test case in CodeSandbox -> https://codesandbox.io/s/github/IBM/carbon-components-react/tree/master/examples/codesandbox - -## Additional information - -- Screenshots or code -- Notes diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index f04a0a9e77..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: "Bug Report \U0001F41B" -about: Create a report to help us improve -title: '' -labels: "type: bug \U0001F41B" -assignees: '' ---- - - - -## Detailed description - -> Describe in detail the issue you're having. - -> Is this issue related to a specific component? - -> What did you expect to happen? What happened instead? What would you like to see changed? - -> What browser are you working in? - -> What version of the Carbon Design System are you using? - -> What offering/product do you work on? Any pressing ship or release dates we should be aware of? - -## Steps to reproduce the issue - -1. Step one -2. Step two -3. Step three -4. etc. - -> Please create a reduced test case in CodeSandbox -> https://codesandbox.io/s/github/IBM/carbon-components-react/tree/master/examples/codesandbox - -## Additional information - -- Screenshots or code -- Notes diff --git a/.github/ISSUE_TEMPLATE/feature-request-or-enhancement---.md b/.github/ISSUE_TEMPLATE/feature-request-or-enhancement---.md deleted file mode 100644 index d0a0596b11..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request-or-enhancement---.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: "Feature request or enhancement \U0001F4A1" -about: Suggest an idea for this project -title: '' -labels: "type: enhancement \U0001F4A1" -assignees: '' ---- - -Use this template if you want to request a new feature, or a change to an existing feature. - -If you are reporting a bug or problem, please use the bug template instead. - -### Summary - -Please describe your request in one or two sentences. - -Clarify if you are asking for both design and development, or just design, or just development. - -### Justification - -Provide the business reasons for this request. - -### Desired UX and success metrics - -Describe the full user experience for this feature. Also define the metrics by which we can measure success/failure for the user. - -### "Must have" functionality - -Highlight any "must have" needs and functionality for the request. - -This should not be a full list of functionality; the Carbon team will work with you to define functionality based on the desired UX. - -### Specific timeline issues / requests - -Do you want this work within a specific time period? Is it related to an upcoming release? - -_NB: The Carbon team will try to work with your timeline, but it's not guaranteed. The earlier you make a request in advance of a desired delivery date, the better!_ - -### Available extra resources - -What resources do you have to assist this effort? - -_Carbon is a collaborative system. We encourage teams to build components and submit them for integration as either add-ons or core components._ diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 6bc6efff35..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Question ❓ -about: Usage question or discussion about Carbon Components React. -title: '' -labels: 'type: question :question:' -assignees: '' ---- - - - -## Summary - -## Relevant information - - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bd3b5aef8d..f2166119aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,6 @@ -Closes IBM/carbon-components-react# + diff --git a/README.md b/README.md index 0c031a36b4..9937f2a903 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,7 @@ -# carbon-components-react +# Project moved to [`carbon-design-system/carbon`](https://github.com/carbon-design-system/carbon) -[![Carbon Components is released under the Apache-2.0 license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE) -[![CircleCI](https://circleci.com/gh/carbon-design-system/carbon-components-react.svg?style=shield)](https://circleci.com/gh/carbon-design-system/carbon-components-react) -[![All Contributors](https://img.shields.io/badge/all_contributors-64-orange.svg?style=flat-square)](#contributors) -[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./.github/CONTRIBUTING.md) +This project has been moved to the Carbon monorepo. The specific package is available [here](https://github.com/carbon-design-system/carbon/tree/master/packages/react). For more information about +this transition, you can check out [this post](https://medium.com/carbondesign/carbon-is-moving-to-a-monorepo-c6bfcbe87de0). -> A collection of [Carbon Components](https://github.com/IBM/carbon-components) implemented using [React](https://reactjs.org/). - -### Getting Started - -Run the following command using [npm](https://www.npmjs.com/): - -```bash -npm install -S carbon-components-react carbon-components carbon-icons -``` - -If you prefer [Yarn](https://yarnpkg.com/en/), use the following command instead: - -```bash -yarn add carbon-components-react carbon-components carbon-icons -``` - -1. These components require the use of [Webpack](http://webpack.github.io/docs/tutorials/getting-started/) in your project. See our [`webpack.config.js`](/.storybook/webpack.config.js) for an example configuration. - -2. Components do not import any of the styles themselves, use the scss or css from `carbon-components` to bring in styling. You can also use the `unpkg` cdn to bring in the styles wholesale - `unpkg.com/carbon-components/css/carbon-components.css` aliases the latest css file. - -3. For older browsers (e.g. IE11), polyfills listed in [`carbon-components-react/.storybook/polyfills.js` file](./.storybook/polyfills.js) is required. - -If you just want to try out `carbon-components-react`, you can also use [CodeSandbox](https://codesandbox.io/s/github/IBM/carbon-components-react/tree/master/examples/codesandbox). - -[![Edit carbon-components-react](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/IBM/carbon-components-react/tree/master/examples/codesandbox) - -## Usage - -### List of Available Components - -View available React Components [here](http://react.carbondesignsystem.com). You can see usage information in several ways: - -1. Clicking the blue **Show Info** icon in the top right corner of the selected component. You can see the list of available React props -2. Clicking the **STORY** tab at the bottom. This tab contains the code that shows how the component is being used -3. Clicking the **KNOBS** tab at the bottom and changing values there. Most knobs are shown as something like `Button kind (kind)`, where `kind` is the name of React prop -4. Clicking the **ACTION LOGGER** tab at the bottom and interacting with the selected component. You may see something like `onClick` which typically indicates that the event handler (React prop) with the same name is called. You can also expand the twistie to see the details of the event -5. Clicking the **README** tab at the bottom. You can see some more document for some components - -# :books: Documentation - -- See our documentation site [here](http://carbondesignsystem.com/getting-started/developers) for full how-to docs and guidelines -- [Contributing](/.github/CONTRIBUTING.md): Guidelines for making contributions to this repo -- [πŸƒβ€β™€οΈ Migration Guides](./docs/migration) - - [v6 to v7](./docs/migration/migrate-to-7.x.md) - -## Contributing - -Please check out our [Contribution Guidelines](./.github/CONTRIBUTING.md) for detailed information on how you can lend a hand. - -To update the `Contributors` section, follow [these instructions](https://github.com/jfmengels/all-contributors-cli#addupdate-contributors) - -## Contributors - -Thanks goes to these wonderful people: - - - -| [
Brian Han](https://github.com/hellobrian)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=hellobrian "Code") | [
Chris Dhanaraj](http://twitter.com/chrisdhanaraj)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=chrisdhanaraj "Code") | [
Nick Sandonato](https://github.com/nsand)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=nsand "Code") | [
TJ Egan](http://tw15egan.github.io/portfolio)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=tw15egan "Code") | [
Mari Johannessen](http://www.marijohannessen.com)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=marijohannessen "Code") | [
Sam Doyle](https://github.com/sam1463)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=sam1463 "Code") | [
alex weidner](https://github.com/shimmerjs)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=shimmerjs "Code") | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| [
Ciaran Hannigan](https://github.com/CiaranHannigan)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=CiaranHannigan "Code") | [
Ian Fleming](http://ianfleming.me/)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=iangfleming "Code") | [
Eddie Monge](http://eddiemonge.com)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=eddiemonge "Code") | [
Reinaldo Cruz](http://www.reicruz.com/)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=reicruz "Code") | [
Yu Cao](https://github.com/ycao56)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=ycao56 "Code") | [
Megan Becvarik](https://github.com/mbecvarik)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=mbecvarik "Code") | [
Astha](https://github.com/AsthaJain1)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=AsthaJain1 "Code") | -| [
Jason Lengstorf](https://code.lengstorf.com)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=jlengstorf "Code") | [
Nathan Friedly](http://nfriedly.com/)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=nfriedly "Code") | [
Matt Hamann](http://mhamann.com)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=mhamann "Code") | [
Greg](https://github.com/gferreri)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=gferreri "Code") | [
Anthony Oliveri](https://github.com/AnthonyOliveri)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=AnthonyOliveri "Code") | [
Jorge Padilla](https://github.com/jlpadilla)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=jlpadilla "Code") | [
German Attanasio](http://germanattanasio.com)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=germanattanasio "Code") | -| [
Ritchie Martori](https://github.com/ritch)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=ritch "Code") | [
Akira Sudoh](http://streetphoto.jp/)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=asudoh "Code") | [
holmansze](https://github.com/holmansze)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=holmansze "Code") | [
Josh Black](https://github.com/joshblack)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=joshblack "Code") [πŸ“–](https://github.com/IBM/carbon-components-react/commits?author=joshblack "Documentation") [πŸ’‘](#example-joshblack "Examples") [πŸš‡](#infra-joshblack "Infrastructure (Hosting, Build-Tools, etc)") | [
Tayler Aitken](http://tayleraitken.com)
[🎨](#design-tay-aitken "Design") [πŸ“–](https://github.com/IBM/carbon-components-react/commits?author=tay-aitken "Documentation") | [
Bethany Sonefeld](http://www.bethanysonefeld.com)
[🎨](#design-bsonefeld "Design") | [
Dmitri Wolf](https://github.com/DmitriWolf)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=DmitriWolf "Code") | -| [
James](https://github.com/jamesvclements)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=jamesvclements "Code") | [
Kade Keith](http://kadekeith.me/)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=keithkade "Code") | [
Mira Murali](https://github.com/miramurali23)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=miramurali23 "Code") | [
alisonemiller](https://github.com/alisonemiller)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=alisonemiller "Code") | [
bjones526](https://github.com/bjones526)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=bjones526 "Code") | [
sandhya-r-reddy](https://github.com/sandhya-r-reddy)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=sandhya-r-reddy "Code") | [
Alison Joseph](https://github.com/alisonjoseph)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=alisonjoseph "Code") | -| [
Dogukan](https://github.com/ereneld)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=ereneld "Code") | [
Erika Dsouza](https://github.com/ehdsouza)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=ehdsouza "Code") | [
Jeroen Schaftenaar](https://github.com/jschaftenaar)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=jschaftenaar "Code") | [
Joseph Meis](http://bluemix.net)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=jmeis "Code") | [
Paul Sachs](https://github.com/psachs21)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=psachs21 "Code") | [
Ryan Mackey](https://github.com/ryanomackey)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=ryanomackey "Code") | [
Toni](https://github.com/tonitagd)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=tonitagd "Code") | -| [
shyfruan](https://github.com/shyfruan)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=shyfruan "Code") | [
Joseph Gordon](https://github.com/JMGordon)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=JMGordon "Code") | [
Logan McCaul](https://github.com/loganmccaul)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=loganmccaul "Code") | [
Matt Chapman](https://github.com/asfordmatt)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=asfordmatt "Code") | [
Scott Dickerson](https://github.com/scottdickerson)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=scottdickerson "Code") | [
DarΓ­o HereΓ±ΓΊ](https://github.com/kant)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=kant "Code") | [
James Zhang](https://github.com/jzhang300)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=jzhang300 "Code") | -| [
Simone Riccardelli](https://github.com/michead)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=michead "Code") | [
Tom](https://github.com/Tom-Danger-Bryant)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=Tom-Danger-Bryant "Code") | [
Zeus Courtois](https://github.com/zeusorion)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=zeusorion "Code") | [
Andrew Daniel](http://www.andrewdaniel.co.uk)
[πŸ›](https://github.com/IBM/carbon-components-react/issues?q=author%3Aajdaniel "Bug reports") [πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=ajdaniel "Code") | [
Andy](https://github.com/AndySeymour2904)
[πŸ›](https://github.com/IBM/carbon-components-react/issues?q=author%3AAndySeymour2904 "Bug reports") [πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=AndySeymour2904 "Code") | [
Nicholas Lee](https://github.com/nicholaslee119)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=nicholaslee119 "Code") | [
David Menendez](http://davidmenendez.net)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=davidmenendez "Code") | -| [
Prashant Farkya](https://github.com/pfarkya)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=pfarkya "Code") | [
Tibor Cz](https://neonwarp.github.io)
[πŸ“–](https://github.com/IBM/carbon-components-react/commits?author=neonwarp "Documentation") | [
Xixiang Chen](https://github.com/nelsonchen90)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=nelsonchen90 "Code") | [
s100](https://github.com/s100)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=s100 "Code") | [
Becca Ellsworth](https://github.com/bellsworth13)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=bellsworth13 "Code") | [
Zack Grossbart](http://www.zackgrossbart.com/)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=zgrossbart "Code") | [
Yohanna Gadelrab](https://github.com/Yohanna)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=Yohanna "Code") [πŸ›](https://github.com/IBM/carbon-components-react/issues?q=author%3AYohanna "Bug reports") [⚠️](https://github.com/IBM/carbon-components-react/commits?author=Yohanna "Tests") [πŸ“–](https://github.com/IBM/carbon-components-react/commits?author=Yohanna "Documentation") | -| [
Carlos Eduardo Monti](http://www.gfxnstuff.com.ar)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=slaytanic "Code") [πŸ“–](https://github.com/IBM/carbon-components-react/commits?author=slaytanic "Documentation") | [
Thomas Brown](https://www.tombrowndev.co.uk)
[πŸ’»](https://github.com/IBM/carbon-components-react/commits?author=tombrowndev "Code") | - - +All issues and pull requests for this package should be made on that repo +instead.