Git Product home page Git Product logo

all-contributors-atom's Introduction

all-contributors-atom

Atom package for easy implementation of all-contributors spec within atom editor

allcontributors.gif

Usage

Open a project using (Why? #1)

atom ProjectName

in your terminal and paste the following towards the end:

<!-- Contributors START
fname_mname_lname githubUsername websiteLink contributionType1 contributionType2
fname_mname_lname githubUsername websiteLink contributionType1 contributionType5 contributionType7
fname_mname_lname githubUsername websiteLink contributionType3
Contributors END -->
<!-- Contributors table START -->
<!-- Contributors table END -->
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.

Hit ctrl+alt+p to parse the contributors list to build contributors' table as specified in the all-contributors spec.

You can reduce the boilerplate to only adding contributers details by using addcon-i snippet on an markdown file. The snippet produces:

<!-- Contributors START
Contributors END -->
<!-- Contributors table START -->
<!-- Contributors table END -->
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.

Adding a contributor

Inside the Contributors START comment, start from a newline, the name of the person concatenated by underscore for breaks(eg. Mayank_Badola), his/her github username, his/her website url and all the types of contributions made by that user.
Make sure you seperate these details by a space character.(eg. Mayank_Badola mbad0la http://mbad0la.github.io code doc)
Press ctrl+alt+p to refresh the tables.

Contribution Types

Type Represents
code Code
utility Plugin/utility libraries
tools Tools
infra Infrastructure (Hosting, Build-Tools, etc)
doc Documentation
translation Translation
answers Answering Questions (in Issues, Stack Overflow, Gitter, Slack, etc.)
tests Tests
bug Bug reports
example Examples
blogpost Blogposts
tutorial Tutorials
video Videos
talks Talks
design Design
prReview Reviewed Pull Requests

Contributors

Mayank Badola
Mayank Badola

๐Ÿ’ป ๐Ÿ“–
Divjot Singh
Divjot Singh

๐Ÿ’ป ๐Ÿ“–
Tam Love
Tam Love

๐Ÿ’ป ๐Ÿ“–
Haz
Haz

๐Ÿ’ป

Any further contributions are more than welcome to help make this utility more awesome!

all-contributors-atom's People

Contributors

bogas04 avatar diegohaz avatar mbad0la avatar taml avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.