add CONTRIBUTING.md, Code of Conduct

Closes 14

CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rpflorence@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+
+**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. If you haven't set up React Native, follow [these instructions](https://facebook.github.io/react-native/docs/getting-started.html)
+2. `$ npm install` to install dependencies
+3. `$ npm run test` to check you've got everything working
+4. Create a branch for your PR
+
+## Project code structure
+This project uses a flat repo structure - all code is put into files in the `modules/` folder. The main reason is that both ``history`` and ``react-router`` repos follow this convention & hacking on this library means hacking on those two as well. Mirroring the conventions used in those repos makes it easier to connect the pieces. It can take time to get used to it, but give it five minutes. ;)
+
+## Code Style
+- We use [eslint](http://eslint.org/) and [flow](https://flowtype.org/). `npm test` checks that the code conforms to the configurations we use for these tools. They are also checked during CI.
+- We use `.editorconfig` to check some basic code style conventions. You can install an [editorconfig plugin](http://editorconfig.org/#download) for your preferred editor so that the relevant settings (tabs vs spaces, amount of indent etc.) are automatically setup when you work on this project.

README.md

@@ -100,6 +100,8 @@ React Router Native is cross-platform. It supports all platforms that [Navigatio
 ### Contributing
 In order to hack on the library code and sync it into `examples/Aviato/node_modules` run `npm run sync` (depends on `npm i -g sane`). The library code is specified as a [local dependency](https://docs.npmjs.com/files/package.json#local-paths) in the example's [`package.json`](https://github.com/jmurzy/react-router-native/blob/master/examples/Aviato/package.json) -- `npm link` does not work with RN packager right now (it's an [open issue](https://productpains.com/post/react-native/symlink-support-for-packager/)).
 
+More info on workflow and setup can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
+
 We look forward to your input! 👊
 
 ### Questions?