Skip to content

Instantly share code, notes, and snippets.

View sp0oks's full-sized avatar

Gabriel Alves sp0oks

  • São Carlos, São Paulo, Brazil
View GitHub Profile
@sp0oks
sp0oks / am-i-ready-to-open-source-this.md
Created June 26, 2017 03:47 — forked from PurpleBooth/am-i-ready-to-open-source-this.md
Checklist to see if your open source repo is primetime ready!

Am I ready to Open Source This?

The checklist:

  1. A readme following a good template
  2. A contributing.md with a code of conduct.
  3. A license
  4. Travis configuration
  5. A way for people to raise issues
  6. Link to it
@sp0oks
sp0oks / README-Template.md
Created June 26, 2017 03:40 — 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