Skip to content

Instantly share code, notes, and snippets.

View umcconnell's full-sized avatar

Ulysse McConnell umcconnell

10 followers · 16 following
View GitHub Profile
@umcconnell
umcconnell / API.md
Created May 11, 2019 14:10 — forked from iros/API.md
Documenting your REST API

Title

<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>

  • URL

    <The URL Structure (path only, no root url)>

  • Method:

@umcconnell
umcconnell / Good-CONTRIBUTING.md-template.md
Created May 9, 2019 16:36 — forked from PurpleBooth/Good-CONTRIBUTING.md-template.md

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a
@umcconnell
umcconnell / README-Template.md
Created May 9, 2019 16:18 — forked from PurpleBooth/README-Template.md
A template to make good README.md

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites