mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-09 08:46:35 +02:00
Code Issues Releases Wiki Activity

update contributing docs

Browse Source
This commit is contained in:
Ian Storm Taylor
2021-04-01 01:20:51 -04:00
parent a406c6a738
commit b650dcaac0
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Contributing.md
View File

@@ -2,14 +2,19 @@
Want to contribute to Slate? That would be awesome! Want to contribute to Slate? That would be awesome!
- [Reporting Bugs](#reporting-bugs) - [Contributing](#contributing)
- [Asking Questions](#asking-questions) - [Reporting Bugs](#reporting-bugs)
- [Submitting Pull Requests](#submitting-pull-requests) - [Asking Questions](#asking-questions)
- [Repository Setup](#repository-setup) - [Submitting Pull Requests](#submitting-pull-requests)
- [Running Examples](#running-examples) - [Repository Setup](#repository-setup)
- [Running Tests](#running-tests) - [Running Examples](#running-examples)
- [Testing Input Methods](#testing-input-methods) - [Running Tests](#running-tests)
- [Publishing Releases](#publishing-releases) - [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 ## 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.) 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 ## 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. [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.