From c0dddf7560dac99e0d55db0eccbd3e22a648ba3b Mon Sep 17 00:00:00 2001 From: Robert Lord Date: Tue, 26 Jan 2016 13:03:37 -0600 Subject: [PATCH] Improve contribution guidelines --- CONTRIBUTING.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b04fc95..cae4eee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,15 @@ -# Contributing to Slate +# Before You Submit an Issue -Thanks for contributing to Slate! A couple of quick guidelines for submitting PRs: +- Are you using Windows? We unfortunately don't support Windows. You could try using Docker, as outlined in the `README`. +- Is your version of Slate out of date? We have [upgrade instructions](https://github.com/tripit/slate/wiki/Updating-Slate) in the wiki. You could also try seeing if your problem is reproducible on the latest version of Slate. -- Please point your pull requests at the `dev` branch, and keep your commit messages clear and informative. +If you answered "no" to each of the questions above, feel free to submit an issue! It's also helpful if you include a code example of your problem (if applicable), we can't help you if you just say "Slate stopped loading for me once I added my documentation" without telling us the problematic documentation. + +# Before You Submit a Pull Request + +Thanks for contributing to Slate! A couple of quick guidelines for submitting pull requests: + +- **Please point your pull requests at the `dev` branch.** We don't accept pull requests to `master`. - Please make sure your contributions work in the most recent version of Chrome, Firefox, and IE. - If you're implementing a new feature, even if it's relatively small, it's nice to open an issue before you start so that others know what you're working on and can help make sure you're on the right track.