From d6b6976b5f00fab220c25b38ca1327b94b31eeb7 Mon Sep 17 00:00:00 2001 From: wbrgss Date: Mon, 23 Jul 2018 17:52:39 -0400 Subject: [PATCH 1/3] Contribution guidelines with @chriddyp's publishing recs --- CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 +++++++++- 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..45eceb58 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing to dash-html-components + +## Getting Started + +Refer to the [readme](README.md) for installation and development workflow instructions. + +## Contributions + +[Dash HTML Components][] consist of generic HTML5 elements based on the [MDN spec][] [1](#f1). For more complex UI components, see the [Dash Core Components][]. Contributions are welcome! This repository's open [Issues][] are a good place to start. + +## Pull Request Guidelines + +Using the [GitHub flow][] is encouraged when proposing contributions to this repository (i.e. creating a feature branch and submitting a PR on the master branch). + +## Coding Style + +Please lint any additions to react components with `npm run lint`. Rules defined in [.eslint](.eslint) are inherited from [`dash-components-archetype`](https://github.com/plotly/dash-components-archetype)'s [eslintrc-react.json](https://github.com/plotly/dash-components-archetype) + +## Publishing New Features + +For substantial new features (i.e. more than bug fixes and minor changes), the following steps are highly encouraged: + +1. Create a pull request and tag the Plotly team `@plotly/dash` as well as an appropriate reviewer (frequent [contributors][] are a safe bet). +2. After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][] To create a prerelease: + * Add `rc1` to `version.py` (`./dash_html_components/version.py`) e.g. `0.13.0rc1` + * Add `-rc1` to `package.json` e.g. `0.13.0-rc1` + * Update the `unpkg` link in `./dash_html_components/__init__.py`, replacing `__version__` with your release candidate (e.g. `"0.13.0-rc1"`) + * Run `npm run publish-all` +3. Comment in the PR with the prerelease version +4. Update the top-level comment to include info about how to install, a summary of the changes, and a simple example. For a good example, see the [Confirmation Modal component][]. + * This makes it easier for a community member to come in and try it out. As more folks review, it's harder to find the installation instructions deep in the PR + * Keep this top-level comment updated with installation instructions (e.g. the `pip install` command) +5. Make a post in the [Dash Community Forum][] + * Title it `":mega: Announcement! New - Feedback Welcome"` + * In the description, link to the PR and any relevant issue(s) + * Pin the topic so that it appears at the top of the forum for two weeks + * For a good example, see the [Confirmation Modal announcement][] + +[Dash HTML Components]: https://dash.plot.ly/dash-html-components +[MDN spec]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element +[Dash Core Components]: https://github.com/plotly/dash-core-components +[Issues]: https://github.com/plotly/dash-html-components/issues +[GitHub flow]: https://guides.github.com/introduction/flow/ +[contributors]: https://github.com/plotly/dash-html-components/graphs/contributors +[eslintrc-react.json]: https://github.com/plotly/dash-components-archetype/blob/master/config/eslint/eslintrc-react.json +[semantic versioning]: https://semver.org/ +[Dash Community Forum]: https://community.plot.ly/c/dash +[Confirmation Modal component]: https://github.com/plotly/dash-core-components/pull/211#issue-195280462 +[Confirmation Modal announcement]: https://community.plot.ly/t/announcing-dash-confirmation-modal-feedback-welcome/11627 + +1 Also see the [W3 index of elements](https://dev.w3.org/html5/html-author/#index-of-elements) [↩](#n1) + diff --git a/README.md b/README.md index 22d01b0a..72134054 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ Vanilla HTML components for [Dash][] -## Contributing +## Getting Started + +### Installation ```sh # Install dependencies @@ -63,8 +65,14 @@ $ npm run install-local $ npm run uninstall-local ``` +## Contributing + +See the [contributing guide](CONTRIBUTING.md) for guidelines on contributing to this project. + ## Publishing +See the [publishing section](CONTRIBUTING.md#publishing-new-features) of the contributing guide for a how-to on releasing a new feature. + ## Builder / Archetype We use [Builder][] to centrally manage build configuration, dependencies, and From 02d3b80dfa9f7c6ab02be0e9457d68fac4247324 Mon Sep 17 00:00:00 2001 From: wbrgss Date: Tue, 24 Jul 2018 12:34:52 -0400 Subject: [PATCH 2/3] Link fixes; financial contributions --- CONTRIBUTING.md | 40 +++++++++++----------------------------- README.md | 2 -- 2 files changed, 11 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45eceb58..94c7673e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,47 +6,29 @@ Refer to the [readme](README.md) for installation and development workflow instr ## Contributions -[Dash HTML Components][] consist of generic HTML5 elements based on the [MDN spec][] [1](#f1). For more complex UI components, see the [Dash Core Components][]. Contributions are welcome! This repository's open [Issues][] are a good place to start. +[Dash HTML Components][] consist of generic HTML5 elements based on the [MDN spec][] [1](#f1). For more complex UI components, see the [Dash Core Components][]. Contributions are welcome! This repository's open [issues][] are a good place to start. + +## Coding Style + +Please lint any additions to react components with `npm run lint`. Rules defined in [.eslintrc](.eslintrc) are inherited from [`dash-components-archetype`](https://github.com/plotly/dash-components-archetype)'s [eslintrc-react.json][] ## Pull Request Guidelines Using the [GitHub flow][] is encouraged when proposing contributions to this repository (i.e. creating a feature branch and submitting a PR on the master branch). -## Coding Style - -Please lint any additions to react components with `npm run lint`. Rules defined in [.eslint](.eslint) are inherited from [`dash-components-archetype`](https://github.com/plotly/dash-components-archetype)'s [eslintrc-react.json](https://github.com/plotly/dash-components-archetype) +## Financial Contributions -## Publishing New Features +If your company wishes to sponsor development of open source dash components, please [get in touch][]. -For substantial new features (i.e. more than bug fixes and minor changes), the following steps are highly encouraged: +### Notes -1. Create a pull request and tag the Plotly team `@plotly/dash` as well as an appropriate reviewer (frequent [contributors][] are a safe bet). -2. After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][] To create a prerelease: - * Add `rc1` to `version.py` (`./dash_html_components/version.py`) e.g. `0.13.0rc1` - * Add `-rc1` to `package.json` e.g. `0.13.0-rc1` - * Update the `unpkg` link in `./dash_html_components/__init__.py`, replacing `__version__` with your release candidate (e.g. `"0.13.0-rc1"`) - * Run `npm run publish-all` -3. Comment in the PR with the prerelease version -4. Update the top-level comment to include info about how to install, a summary of the changes, and a simple example. For a good example, see the [Confirmation Modal component][]. - * This makes it easier for a community member to come in and try it out. As more folks review, it's harder to find the installation instructions deep in the PR - * Keep this top-level comment updated with installation instructions (e.g. the `pip install` command) -5. Make a post in the [Dash Community Forum][] - * Title it `":mega: Announcement! New - Feedback Welcome"` - * In the description, link to the PR and any relevant issue(s) - * Pin the topic so that it appears at the top of the forum for two weeks - * For a good example, see the [Confirmation Modal announcement][] +1 Also see the [W3 index of elements](https://dev.w3.org/html5/html-author/#index-of-elements) [↩](#n1) [Dash HTML Components]: https://dash.plot.ly/dash-html-components [MDN spec]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element [Dash Core Components]: https://github.com/plotly/dash-core-components -[Issues]: https://github.com/plotly/dash-html-components/issues +[issues]: https://github.com/plotly/dash-html-components/issues [GitHub flow]: https://guides.github.com/introduction/flow/ -[contributors]: https://github.com/plotly/dash-html-components/graphs/contributors [eslintrc-react.json]: https://github.com/plotly/dash-components-archetype/blob/master/config/eslint/eslintrc-react.json -[semantic versioning]: https://semver.org/ -[Dash Community Forum]: https://community.plot.ly/c/dash -[Confirmation Modal component]: https://github.com/plotly/dash-core-components/pull/211#issue-195280462 -[Confirmation Modal announcement]: https://community.plot.ly/t/announcing-dash-confirmation-modal-feedback-welcome/11627 - -1 Also see the [W3 index of elements](https://dev.w3.org/html5/html-author/#index-of-elements) [↩](#n1) +[get in touch]: https://plot.ly/products/consulting-and-oem diff --git a/README.md b/README.md index 72134054..2e9aaf50 100644 --- a/README.md +++ b/README.md @@ -71,8 +71,6 @@ See the [contributing guide](CONTRIBUTING.md) for guidelines on contributing to ## Publishing -See the [publishing section](CONTRIBUTING.md#publishing-new-features) of the contributing guide for a how-to on releasing a new feature. - ## Builder / Archetype We use [Builder][] to centrally manage build configuration, dependencies, and From b743d7f8c499abe7b1a58a32322d63360ac95c98 Mon Sep 17 00:00:00 2001 From: wbrgss Date: Wed, 25 Jul 2018 10:14:53 -0400 Subject: [PATCH 3/3] Suggestions from @cldougl (PR #52) --- CONTRIBUTING.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94c7673e..e186524e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Refer to the [readme](README.md) for installation and development workflow instr ## Contributions -[Dash HTML Components][] consist of generic HTML5 elements based on the [MDN spec][] [1](#f1). For more complex UI components, see the [Dash Core Components][]. Contributions are welcome! This repository's open [issues][] are a good place to start. +[Dash HTML Components][] consist of generic HTML5 elements based on the [MDN spec][] (also see the [W3 index of elements][]). For more complex UI components, see the [Dash Core Components][]. Contributions are welcome! This repository's open [issues][] are a good place to start. ## Coding Style @@ -14,18 +14,15 @@ Please lint any additions to react components with `npm run lint`. Rules defined ## Pull Request Guidelines -Using the [GitHub flow][] is encouraged when proposing contributions to this repository (i.e. creating a feature branch and submitting a PR on the master branch). +Use the [GitHub flow][] when proposing contributions to this repository (i.e. create a feature branch and submit a PR against the master branch). ## Financial Contributions If your company wishes to sponsor development of open source dash components, please [get in touch][]. -### Notes - -1 Also see the [W3 index of elements](https://dev.w3.org/html5/html-author/#index-of-elements) [↩](#n1) - [Dash HTML Components]: https://dash.plot.ly/dash-html-components -[MDN spec]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element +[MDN spec]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element +[W3 index of elements](https://dev.w3.org/html5/html-author/#index-of-elements) [Dash Core Components]: https://github.com/plotly/dash-core-components [issues]: https://github.com/plotly/dash-html-components/issues [GitHub flow]: https://guides.github.com/introduction/flow/