Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Mar 9, 2021. It is now read-only.

Add index to contributing.md #110

Closed
M-ZubairAhmed opened this issue Nov 20, 2017 · 3 comments
Closed

Add index to contributing.md #110

M-ZubairAhmed opened this issue Nov 20, 2017 · 3 comments
Labels
Difficulty:beginner Docs first-timers-only good-first-issue Issue Taken

Comments

@M-ZubairAhmed
Copy link

M-ZubairAhmed commented Nov 20, 2017 •
edited by vinaypuppal
Loading

Lets add an index/Table of content to Contributing.md as the file is contains a quite a bit of content making it difficult to skim read.

Please make sure you do read CONTRIBUTING.MD as we have changed a few things and made it a lot simpler for people to contribute.
@vinaypuppal
Copy link
Contributor

We can use https://github.com/thlorenz/doctoc

@majidmazin
Copy link
Contributor

I would like to work on this.

@vinaypuppal
Copy link
Contributor

@majidmazin Sure go ahead. I will list few steps you can follow and use https://github.com/thlorenz/doctoc to generate TOC easily

  1. Fork this repo as mentioned here (First 3 steps) https://github.com/coderplex/coderplex/blob/develop/.github/CONTRIBUTING.md#running-locally
  2. Install doctoc using NPM 
    npm install -g doctoc
  3. Inside coderplex project run below command to generate TOC for Contributing.md file 
    doctoc ./.github/CONTRIBUTING.md
  4. Finally commit these changes and submit your PR

@majidmazin majidmazin mentioned this issue Nov 28, 2017
Merged
5 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Difficulty:beginner Docs first-timers-only good-first-issue Issue Taken
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vinaypuppal @M-ZubairAhmed @majidmazin