Skip to content

Instantly share code, notes, and snippets.

View ww2's full-sized avatar

Wes Price ww2

View GitHub Profile
@PurpleBooth
PurpleBooth / am-i-ready-to-open-source-this.md
Last active February 4, 2021 22:17
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
@PurpleBooth
PurpleBooth / Good-CONTRIBUTING.md-template.md
Last active April 27, 2024 00:41

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
@PurpleBooth
PurpleBooth / README-Template.md
Last active May 3, 2024 03:58
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