Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.71 KB
Raw

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Setup

Prerequisites

You need to have Node.js, NVM, NPM and Jekyll installed on your computer.

$ node --version
v4.6.0

$ npm --version
2.15.9

$ jekyll --version
jekyll 3.1.2

Fork our repo

  1. Fork the repo: https://github.com/opentracing/opentracing.io
  2. Run the following commands:
$ git clone https://github.com/<YOUR_USERNAME>/opentracing.io
$ cd opentracing.io
$ nvm use
$ npm install

Running opentracing.io locally

$ npm run dev
$ open http://localhost:4000

Pull Requests

  1. Create a branch from master
  2. Make sure it builds without any issues
  3. Write a good commit message
  4. Push it to your fork
  5. Create a pull request here

License

By contributing to opentracing.io, you agree that your contributions will be licensed under its Apache 2.0 License.

Project Structure

_data

collections of data that is used to render our liquid templates.

_docs

The gitbook documentation that is then built into /documentation on build.

_includes, _layouts

jekyll folders containing templates and layouts.

_sass

scss that is then preprocessed into /css on build.

_site

Jekyll temp folder when running jekyll serve. You can ignore this.

fonts, img

static content.

css, documentation

post-build static assets. don't edit these.