Contributing

want to contribute to slate? that would be awesome! contributing docid\ f5bnc4lx3bhybcwwfxu9areporting bugs docid\ f5bnc4lx3bhybcwwfxu9aasking questions docid\ f5bnc4lx3bhybcwwfxu9asubmitting pull requests docid\ f5bnc4lx3bhybcwwfxu9arepository setup docid\ f5bnc4lx3bhybcwwfxu9arunning examples docid\ f5bnc4lx3bhybcwwfxu9arunning tests docid\ f5bnc4lx3bhybcwwfxu9atesting input methods docid\ f5bnc4lx3bhybcwwfxu9apublishing releases docid\ f5bnc4lx3bhybcwwfxu9apublishing normal @latest release docid\ f5bnc4lx3bhybcwwfxu9apublishing @next release docid\ f5bnc4lx3bhybcwwfxu9apublishing @experimental release docid\ f5bnc4lx3bhybcwwfxu9arunning prerelease script docid\ f5bnc4lx3bhybcwwfxu9a reporting bugs 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 any issue you open must include a jsfiddle https //jsfiddle net/01plxfzu/ that reproduces the bug with a minimal setup a gif showing the issue in action (using something like recordit http //recordit co/ ) a clear explanation of what the issue is here's a jsfiddle template for slate https //jsfiddle net/01plxfzu/ to get you started https //jsfiddle net/01plxfzu/ asking questions 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 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 all pull requests are super welcomed and greatly appreciated! issues in need of a solution are marked with a ♥ help https //github com/ianstormtaylor/slate/issues?q=is%3aissue+is%3aopen+label%3a%22%e2%99%a5+help%22 label if you're looking for somewhere to start please include tests and docs with every pull request! repository setup the slate repository is a monorepo that is managed with lerna https //github com/lerna/lerna unlike more traditional repositories, this means that the repository must be built in order for tests, linting, or other common development activities to function as expected to run the build, 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 with yarn and build the monorepo yarn install yarn build running examples to run the examples, start by building the monorepo as described in the repository setup docid\ f5bnc4lx3bhybcwwfxu9a section then you can start the examples server with yarn start running tests to run the tests, start by building the monorepo as described in the repository setup docid\ f5bnc4lx3bhybcwwfxu9a section then you can rerun the tests with yarn test if you need to debug something, you can add a debugger line to the source, and then run yarn test\ inspect 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 yarn lint this will catch typescript, prettier, and eslint errors yarn fix this will fix prettier and eslint errors running integration tests to run integrations with cypress https //github com/cypress io/cypress , first run yarn start to run the examples website, then run yarn cypress\ open in a separate session to open the cypress gui 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 publishing releases important when creating releases using lerna with the instructions below, you will be given choices around how to increase version numbers you should always use a major , minor or patch release and must never use a prerelease if a prerelease is used, the root package will not link to the packages in the packages directory creating hard to diagnose issues publishing normal @latest release since we use lerna https //lerna js org to manage the slate packages this is fairly easy, just run yarn release\ latest and follow the prompts lerna gives you note that this will automatically run the prelease script first that will build, test and lint before attempting to publish publishing @next release if we are unsure as to the stability of a release because there are significant changes and/or particularly complex changes, release with the @next tag yarn release\ next and follow the prompts lerna gives you publishing @experimental release if you need to create an experimental release to see how a published package will behave during an actual publish, release with the @experimental tag end users should have no expectation that an @experimental release will be usable yarn release\ experimental running prerelease script if we want to make sure that slate code follows the preparations for a release but without actually publishing, run yarn prerelease which will build, test and lint slate code