Add project docs

Author: mattphillips

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!--
+Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
+
+If you are raising a bug uncomment the next section and fill in the relevant information.
+
+If you would like to request a feature then uncomment the last section :)
+-->
+
+<!--
+**Bug**
+
+- `babel-jest-assertions` version:
+- `node` version:
+- `npm` (or `yarn`) version:
+
+Relevant code or config
+
+```javascript
+
+```
+
+What you did:
+
+What happened (please provide anything you think will help):
+
+Reproduction repository (if possible):
+
+-->
+
+<!--
+**Feature Request**
+
+Description:
+
+Possible solution:
+
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!--
+Thanks for spending the time to send this PR :D.
+
+Please fill out the information below and make sure you're familiar
+with the contributing guidelines (found in the CONTRIBUTING.md file).
+-->
+
+<!-- What changes are being made? (feature/bug) -->
+### What
+
+<!-- Why are these changes necessary? Link any related issues -->
+### Why
+
+<!-- If necessary add any additional notes on the implementation -->
+### Notes
+
+### Housekeeping
+
+- [ ] Unit tests
+- [ ] Documentation is up to date
+- [ ] No additional lint warnings

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+Thanks for being willing to contribute!
+
+**Working on your first Pull Request?** You can learn how from this *free* series
+[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+
+## Project setup
+
+1. Fork and clone the repo
+2. `$ yarn install` to install dependencies
+3. `$ yarn test` to validate you've got it working
+4. Create a branch for your PR
+
+## Making changes
+
+ - All changes should have unit tests
+ - Any relevant documentation should be updated
+ - No linting warnings/errors should be introduced
+
+## Committing and Pushing changes
+
+Once you are ready to commit the changes, please use the below commands
+
+1. `git add <files to be comitted>`
+2. `git commit -m 'A meaningful message`
+
+*Note: please use present tense in commit messages i.e. `Add feature X` and not ~`Added feature X`~*
+
+## Add yourself as a contributor
+
+This project follows the [all contributors](https://github.com/kentcdodds/all-contributors)
+specification. To add yourself to the table of contributors on the README.md, please use
+the automated script as part of your PR:
+
+```console
+yarn contributor <YOUR_GITHUB_USERNAME>
+```
+
+Follow the prompt. If you've already added yourself to the list and are making a
+new type of contribution, you can run it again and select the added contribution
+type. If you need to edit the `.all-contributorsrc` file by hand that's fine
+too, just run `yarn contributor:generate` to regenerate the table
+
+## Help needed
+
+Please checkout the [ROADMAP](docs/ROADMAP.md) and raise an issue to discuss
+any of the items

README.md

@@ -14,6 +14,8 @@
 [![downloads](https://img.shields.io/npm/dm/babel-jest-assertions.svg?style=flat-square)](http://npm-stat.com/charts.html?package=babel-jest-assertions&from=2017-09-14)
 [![MIT License](https://img.shields.io/npm/l/babel-jest-assertions.svg?style=flat-square)](https://github.com/mattphillips/babel-jest-assertions/blob/master/LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+[![Roadmap](https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square)](https://github.com/mattphillips/babel-jest-assertions/blob/master/docs/ROADMAP.md)
+[![Examples](https://img.shields.io/badge/%F0%9F%92%A1-examples-ff615b.svg?style=flat-square)](https://github.com/mattphillips/babel-jest-assertions/tree/master/examples)
 
 ## Problem
 

docs/EXAMPLES.md

@@ -0,0 +1,4 @@
+# Examples
+
+☹️ None created yet, fancy adding some? See [CONTRIBUTING](https://github.com/mattphillips/babel-jest-assertions/blob/master/CONTRIBUTING.md)
+

docs/ROADMAP.md

@@ -0,0 +1,3 @@
+# Project Roadmap
+
+## Want something added? Feel free to open an issue :)