Skip to content

Instantly share code, notes, and snippets.

@maxrolon
Last active August 16, 2016 22:11
Show Gist options
  • Save maxrolon/23b21b0c85956e8a24aa383bc40d7dcc to your computer and use it in GitHub Desktop.
Save maxrolon/23b21b0c85956e8a24aa383bc40d7dcc to your computer and use it in GitHub Desktop.
Contributing Eg

Contributing

Feel free to post anything you feel may be useful to another team member. In order to add a resource, all you need is the following:

  • A link to a code repository or Github Gist.
  • A .README file (If you're linking to a code repository).
  • Intuitive code comments (block and inline).

README.md Formatting

When adding to this repository's README file, please format resources in the following way:

- **[Resource Title](https://barrelny.com)** - Subtitle

  The resource description. Extend on the title. Provide an executive summary of the resource.

  ###### *Tagged: Tag 1, Tag 2, Tag 3* – Author: @barreldeveloper

The example above has the following elements:

  • A linked title. The link points to the Gist or repository URL.
  • A subtitle. Summarize the core functionality of the resource in a few words.
  • A Description. Keep succinct (1-3 sentences).
  • Tags. Consider the keywords you may search for when looking for this research. Include the platform (if applicable) and language.

Generic tags to use

As a baseline, select a few tags from the lists below. By using generic tags, we make searching through resources easier.

Language

  • JS
  • CSS
  • Less
  • Sass
  • PHP
  • Ruby
  • Liquid
  • Bash

Platform

  • Node
  • Wordpress
  • Drupal
  • Shopify
  • Cratejoy
  • Vae
  • Laravel

Dependencies

  • Bootstrap
  • jQuery
  • ES2015

State

  • WIP
  • Production Ready
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment