Skip to content

Commit

Permalink
Merge pull request #91 from opentable/readme-troubleshooting
Browse files Browse the repository at this point in the history
Adding 'troubleshooting' section
  • Loading branch information
matteofigus committed Aug 6, 2015
2 parents 65997ce + 31136c0 commit 13e76cd
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The goal is to own a system that allows big corporations (that may involve hundr

[![Sauce Test Status](https://saucelabs.com/browser-matrix/matteofigus.svg)](https://saucelabs.com/u/matteofigus)

Disclaimer: This project is still under heavy development and the API is likely to change at any time. In case you would find any issues, check the [troubleshooting page](contributing.md#troubleshooting).

# Index
1. [Introduction](#introduction)
1. [Components](#components)
Expand Down Expand Up @@ -273,7 +275,7 @@ MIT
# Contributors
If you wish to contribute, feel free to open or comment to issues, or [get in touch via twitter](https://twitter.com/OpenTableTechUK)
If you wish to contribute, check the [contributing guidelines](contributing.md).
Maintainer:
* [@matteofigus](https://github.com/matteofigus)
Expand Down
14 changes: 14 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Contributing guidelines
=======================

Contributes are more than welcome!

### Troubleshooting

If you find an issue, feel free to check the [issues](/issues) page, and open a new one if you need.

### Sending a Pull Request

If you want to send a Pull Request, ensure you join the conversation first on the [issues page](/issues)! This is to avoid multiple people working on the same thing. You can get in touch via the [chat](https://gitter.im/opentable/oc) too.

When preparing a pull request, ensure all the tests pass locally running `grunt test-local`. If you have admin rights, open a new branch on the upstream opentable repo.

0 comments on commit 13e76cd

Please sign in to comment.