From 74a553f22eba062445228026e6412feeb28ed114 Mon Sep 17 00:00:00 2001 From: Pixelastic Date: Mon, 20 Aug 2018 13:53:31 +0200 Subject: [PATCH] docs(contributing): Update contributing info about docs --- CONTRIBUTING.md | 59 +++++++++++++++++++++++++++++++------------------ 1 file changed, 37 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 009a4661..3abfc5ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,25 +4,27 @@ Hi (future) collaborator! **Table of Contents** -- [Where to start?](#where-to-start) -- [Development workflow](#development-workflow) - - [Requirements](#requirements) - - [Launch](#launch) - - [Local build](#local-build) -- [Commit message guidelines](#commit-message-guidelines) - - [Revert](#revert) - - [Type](#type) - - [Scope](#scope) - - [Subject](#subject) - - [Body](#body) - - [Footer](#footer) -- [Releasing](#releasing) +- [Where to start?][1] +- [Development workflow][2] + - [Requirements][3] + - [Launch][4] + - [Local build][5] +- [Commit message guidelines][6] + - [Revert][7] + - [Type][8] + - [Scope][9] + - [Subject][10] + - [Body][11] + - [Footer][12] +- [Releasing][13] # Where to start? -Have a fix or a new feature? [Search for corresponding issues](https://github.com/algolia/docsearch/issues) first then create a new one. +Have a fix or a new feature? [Search for corresponding +issues][14] first then create a new +one. # Development workflow @@ -30,9 +32,8 @@ Have a fix or a new feature? [Search for corresponding issues](https://github.co To run this project, you will need: -- Node.js >= v8.7.0, use nvm - [install instructions](https://github.com/creationix/nvm#install-script) -- [Ruby](https://www.ruby-lang.org/en/) -- [Bundler](http://bundler.io/) +- Node.js >= v8.7.0, use nvm - [install + instructions][15] ## Build @@ -40,7 +41,7 @@ To run this project, you will need: minified files for `