evanhsu / api_docs

TSheets API Documentation

api_docs

REST API Documentation for TSheets by QuickBooks

Support:
Documentation:
License:

This Git Repository is the official reference to the REST API Documentation of TSheets (time capture segment of Intuit). Some of the features include:

• TSheets free trial information
• Quick start walkthroughs for developing to the API
• Comprehensive API references
• Code samples in multiple languages
• Best practices, tips & suggestions
• Detailed OAuth2 information
• Access to Postman Collection
• Information about our Partnership Progam

Contribute:

We greatly encourage contributions! You can report and fix existing documentation bugs. Feel free to open issues and/or send pull requests.

The master branch of this repository contains the latest stable release of the API documentation. Pull requests should be submitted against master by forking this repo into your account, developing and testing your changes, and creating pull requests to request merges. See the Contributing to a Project article for more details about how to contribute.

Steps to Contribute:

1. Fork this repository into your account on Github
2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/api_docs.git
3. Develop and validate your changes (see below)
4. Update the changelog with a brief summary of the changes you made.
5. Create a pull request for review to request merge
6. Obtain approval before your changes can be merged

Steps to Build and Validate Changes

1. Install and launch Docker for Mac or Windows.
2. Clone your forked repository (as above)
3. Make your changes
4. Build your changes: ./macbuild.sh or winbuild.cmd
5. Validate changes by viewing ./build/index.html in a browser. Iterate steps 3 - 5.

Thank you for your contribution!