mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-31 10:51:44 +02:00
update contributing docs
This commit is contained in:
@@ -3,8 +3,35 @@
|
|||||||
|
|
||||||
Want to contribute to Slate? That would be awesome!
|
Want to contribute to Slate? That would be awesome!
|
||||||
|
|
||||||
|
- [Opening Issues](#opening-issues)
|
||||||
|
- [Pull Requests](#pull-requests)
|
||||||
|
- [Running Tests](#running-tests)
|
||||||
|
- [Running Examples](#running-examples)
|
||||||
|
- [Browser Support](#browser-support)
|
||||||
|
|
||||||
### Running Tests
|
|
||||||
|
## Reporting Bugs
|
||||||
|
|
||||||
|
If you run into any weird behavior while using Slate, feel free to open a new issue in this repository! To be most helpful, please include the steps to reproduce the bug as best you can, ideally including a [JSFiddle](https://jsfiddle.net/2zokvrvt/4/) with a working example of the bug.
|
||||||
|
|
||||||
|
Here's a [JSFiddle template for Slate](https://jsfiddle.net/2zokvrvt/4/) to get you started:
|
||||||
|
|
||||||
|
[](https://jsfiddle.net/2zokvrvt/4/)
|
||||||
|
|
||||||
|
|
||||||
|
## Asking Questions
|
||||||
|
|
||||||
|
Questions are very welcome :smile:! Previous questions that folks have asked are tagged with a [`question`](https://github.com/ianstormtaylor/slate/issues?q=is%3Aissue+is%3Aclosed+label%3Aquestion) label, so before opening a new issue double-check that someone hasn't asked it before. But if you don't see anything, or if you're not sure if it's the same, err on the side of asking!
|
||||||
|
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
|
||||||
|
All pull requests are super welcomed and greatly appreciated! Easy issues are marked with an [`easy-one`](https://github.com/ianstormtaylor/slate/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy-one) label if you're looking for a simple place to get familiar with the code base.
|
||||||
|
|
||||||
|
Please include tests and docs with every pull request!
|
||||||
|
|
||||||
|
|
||||||
|
## Running Tests
|
||||||
|
|
||||||
To run the examples, you need to have the Slate repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`.
|
To run the examples, you need to have the Slate repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`.
|
||||||
|
|
||||||
@@ -35,19 +62,12 @@ npm run dist:watch
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Running Examples
|
## Running Examples
|
||||||
|
|
||||||
Check out the [Examples readme](./examples) to see how to get the examples running locally!
|
Check out the [Examples readme](./examples) to see how to get the examples running locally!
|
||||||
|
|
||||||
|
|
||||||
### Pull Requests
|
## Browser Support
|
||||||
|
|
||||||
All pull requests are super welcomed and greatly appreciated! Easy issues are marked with an [`easy-one`](https://github.com/ianstormtaylor/slate/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy-one) label if you're looking for a simple place to get familiar with the code base.
|
|
||||||
|
|
||||||
Please include tests and docs with every pull request!
|
|
||||||
|
|
||||||
|
|
||||||
### Browser Support
|
|
||||||
|
|
||||||
Slate aims to targeted all of the modern browsers, and eventually the modern mobile platforms. Right now browser support is limited to the latest versions of [Chrome](https://www.google.com/chrome/browser/desktop/), [Firefox](https://www.mozilla.org/en-US/firefox/new/), and [Safari](http://www.apple.com/safari/), but if you are interested in adding support for another modern platform, that is welcomed!
|
Slate aims to targeted all of the modern browsers, and eventually the modern mobile platforms. Right now browser support is limited to the latest versions of [Chrome](https://www.google.com/chrome/browser/desktop/), [Firefox](https://www.mozilla.org/en-US/firefox/new/), and [Safari](http://www.apple.com/safari/), but if you are interested in adding support for another modern platform, that is welcomed!
|
||||||
|
|
||||||
|
BIN
docs/images/jsfiddle.png
Normal file
BIN
docs/images/jsfiddle.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 170 KiB |
Reference in New Issue
Block a user