mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-03-05 21:49:06 +01:00
Code Issues Releases Wiki Activity

update issue template and contributing docs

Browse Source
This commit is contained in:
Ian Storm Taylor 2017-07-20 10:30:40 -07:00
parent 6123985c4f
commit 3eebb71a9c
2 changed files with 19 additions and 9 deletions

20
.github/ISSUE_TEMPLATE.md vendored

@ -2,7 +2,7 @@
#### Do you want to request a *feature* or report a *bug*?
<!--
If you have a question, you might ask it in our Slack channel instead.
If you have a question, ask it in our Slack channel instead:
https://slate-slack.herokuapp.com/
-->
@ -10,11 +10,15 @@ https://slate-slack.herokuapp.com/
#### What's the current behavior?
<!--
For bugs, please create a JSFiddle that reproduces the issue using
our template, and include a GIF showing how to easily reproduce it.
For bugs, please include the following:
And for bugs please include your OS, browser, Slate version and any
other bit of info that may track down why it's happening.
- A JSFiddle that reproduces the issue.
- A GIF showing how to easily reproduce it.
- Information about your OS, browser, Slate version, etc.
If you don't include these helpful things, there's a very good chance your issue won't get addressed, or will be closed when we do spring cleaning.
We need to keep the issues actionable, or else maintaining Slate becomes overwhelming. Thank you for understanding!
https://jsfiddle.net/2zokvrvt/7/
http://recordit.co/
@ -23,7 +27,11 @@ http://recordit.co/
#### What's the expected behavior?
<!--
Researching how other editors handle this issue is super helpful!
The fastest, and most appreciated way to have your issue fixed is to create a pull request with working, tested code and we will help get it merged. Don't be scared to open a pull request that isn't completed and ask for input. We're happy to give direction!
Slate is solving a pretty complex problem, and we can't do it without active contributors. Thank you so much for your help!
Also, researching how other editors handle this issue is super helpful!
https://draftjs.org/
http://prosemirror.net/

8
Contributing.md

@ -13,7 +13,9 @@ Want to contribute to Slate? That would be awesome!
## 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/7/) with a working example of the bug.
If you run into any weird behavior while using Slate, feel free to open a new issue in this repository! Please run a **search before opening** a new issue, to make sure that someone else hasn't already reported or solved the bug you've found.
To be most helpful, please include the steps to reproduce the bug as best you can, ideally including a [JSFiddle](https://jsfiddle.net/2zokvrvt/7/) with a working example of the bug.
Here's a [JSFiddle template for Slate](https://jsfiddle.net/2zokvrvt/7/) to get you started:
@ -22,12 +24,12 @@ Here's a [JSFiddle template for Slate](https://jsfiddle.net/2zokvrvt/7/) to get
## 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!
We've also got a [Slate Slack team](https://slate-slack.herokuapp.com) where you can ask questions and get answers from other people using Slate:
[![](./docs/images/slack.png)](https://slate-slack.herokuapp.com)
Please use the Slack instead of asking questions in issues, since we want to reserve issues for keeping track of bugs and features. We close questions in issues so that maintaining the project isn't overwhelming.
## Submitting Pull Requests