add code of conduct and contributing guides (#16)

Closes #9

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Introduction
+
+Thanks for considering contributing to `backstop-crawl`. It's just small project but we're always open to new ideas or bug fixes. Keep reading to find out how to get involved.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalise your pull requests.
+
+Contributions can come in many forms, and we're happy to review any ideas you might have. Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions.
+
+# Ground Rules
+
+* Ensure cross-platform compatibility for every change as much as possible.
+* Ensure that code that goes into core passes all the tests and new code gets new tests.
+* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
+* Keep feature versions as small as possible, preferably one new feature per version.
+* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+# Your First Contribution
+
+Unsure where to begin? You can start by looking through the issues, especially issues with the [`ready`](https://github.com/fffunction/backstop-crawl/issues?q=is%3Aissue+is%3Aopen+label%3Aready) or [`pr welcome`](https://github.com/fffunction/backstop-crawl/labels/pr%20welcome). Try to avoid and issues that are labelled as `in progress` or are assigned to someone else.
+
+**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)
+
+At this point, you're ready to make your changes! Feel free to ask questions or for help; everyone is a beginner at first :smile_cat:
+
+# Getting started
+
+For something that is bigger than a one or two line fix:
+
+1. Create an issue so that we can discuss whether it would be a good fit for the project. We don't want to waste any of your time.
+1. Create your own fork of the code
+1. Do the changes in your fork
+1. Write tests for your changes, ensuring all tests pass and the code coverage doesn't fall.
+1. Submit a pull request that explains the what and why
+1. Wait for a maintainer to review that changes, at which point they might:
+  * Ask for changes
+  * Merge the pull request
+
+Please be aware that maintainers can be busy and large changes can be time consuming to review. Don't get discouraged if it takes a long time to review, changes are required, or the pull request is declined. We're very grateful for any input.
+
+For something small:
+
+Small changes are great and easy to review, so just submit a pull request You can either do the whole fork/pr process outlined above or you can use the GitHub website editor. Passing tests and code coverage still matter!
+
+# How to report a bug
+
+If you find a security vulnerability, do NOT open an issue. Email [[email protected]](mailto:[email protected]) instead.
+
+Before creating an issue, search the issues in case someone else has already made one on the same topic. It's better for everyone if the discussion can be focused in one location.
+
+When reporting a bug, make sure to answer these five questions:
+
+1. What version of `backstop-crawl` are you using?
+1. What version of node are you using? `node -v`
+2. What operating system are you using?
+3. What did you do?
+4. What did you expect to see?
+5. What did you see instead?
+
+# How to suggest a feature or enhancement
+
+`backstop-crawl` is a tool that should make it as easy as possible to get started with regression testing, or retroactively add regression testing.
+
+If you have an idea for a feature that would aid these ideals you can open an issue detailing the feature you'd like to see, why you need it, and how it should work. If you're going to start work on the feature you should mention this and assign the issue to yourself.
+
+# Code review process
+
+Issues and Pull Requests are reviewed ad hoc. Don't get discouraged if no one seems to be replying, they are probably just busy.
+
+To make reviews as easy as possible for maintainers please make sure you're following the guidelines above. Maintainers might ask for changes and will do their best to explain why. While we're open to discussion, maintainers have the final word. Maintainers hold full rights to close issue and reject pull requests. They are under no obligations to you.
+
+Once a maintainer has reviewed and okayed a pull request it will be merged into master and published on the next release.
+
+# Thanks
+
+Thanks again for considering contributing to `backstop-crawl` :heart: