Skip to content

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

License

Notifications You must be signed in to change notification settings

o-d-i-n/all-contributors-atom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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!

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •