Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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][] (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

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

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][].

[Dash HTML Components]: https://dash.plot.ly/dash-html-components
[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/
[eslintrc-react.json]: https://github.com/plotly/dash-components-archetype/blob/master/config/eslint/eslintrc-react.json
[get in touch]: https://plot.ly/products/consulting-and-oem

8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Vanilla HTML components for [Dash][]


## Contributing
## Getting Started

### Installation

```sh
# Install dependencies
Expand Down Expand Up @@ -63,6 +65,10 @@ $ npm run install-local
$ npm run uninstall-local
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) for guidelines on contributing to this project.

## Publishing

## Builder / Archetype
Expand Down