mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-11 09:43:58 +02:00
update contributing docs
This commit is contained in:
@@ -2,6 +2,7 @@
|
||||
|
||||
Want to contribute to Slate? That would be awesome!
|
||||
|
||||
- [Contributing](#contributing)
|
||||
- [Reporting Bugs](#reporting-bugs)
|
||||
- [Asking Questions](#asking-questions)
|
||||
- [Submitting Pull Requests](#submitting-pull-requests)
|
||||
@@ -10,6 +11,10 @@ Want to contribute to Slate? That would be awesome!
|
||||
- [Running Tests](#running-tests)
|
||||
- [Testing Input Methods](#testing-input-methods)
|
||||
- [Publishing Releases](#publishing-releases)
|
||||
- [Publishing Normal `@latest` Release](#publishing-normal-latest-release)
|
||||
- [Publishing `@next` Release](#publishing-next-release)
|
||||
- [Publishing `@experimental` Release](#publishing-experimental-release)
|
||||
- [Running Prerelease Script](#running-prerelease-script)
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
@@ -74,6 +79,14 @@ If you need to debug something, you can add a `debugger` line to the source, and
|
||||
|
||||
If you only want to run a specific test or tests, you can run `yarn test --fgrep="slate-react rendering"` flag which will filter the tests being run by grepping for the string in each test. (This is a Mocha flag that gets passed through.)
|
||||
|
||||
In addition to tests you should also run the linter:
|
||||
|
||||
```shell
|
||||
yarn lint
|
||||
```
|
||||
|
||||
This will catch TypeScript, Prettier, and Eslint errors.
|
||||
|
||||
## Testing Input Methods
|
||||
|
||||
[Here's a helpful page](https://github.com/Microsoft/vscode/wiki/IME-Test) detailing how to test various input scenarios on Windows, Mac and Linux.
|
||||
|
Reference in New Issue
Block a user