https://github.com/bzon/gitgraph-ci-branching
https://github.com/bzon/gitgraph-ci-branching
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bzon/gitgraph-ci-branching
- Owner: bzon
- License: mit
- Created: 2016-08-24T09:30:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-14T04:18:06.000Z (almost 10 years ago)
- Last Synced: 2025-01-22T08:28:41.035Z (over 1 year ago)
- Language: JavaScript
- Size: 272 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](http://travis-ci.org/nicoespeon/gitgraph.js) [](https://david-dm.org/nicoespeon/gitgraph.js#info=devDependencies)
===========
A JavaScript library to draw pretty git graphs in the browser.
Project page:
## How to start
You have different options to start with the library:
- [Download the latest release](https://github.com/nicoespeon/gitgraph.js/releases/latest).
- Clone the repo: `git clone git://github.com/nicoespeon/gitgraph.js.git`.
- Install with [Bower](http://bower.io/): `bower install gitgraph.js`.
- Use [the CDNjs hosted lib](https://cdnjs.com/libraries/gitgraph.js).
Production files are available under the `build/` directory.
## Report a bug / Ask for a feature
You found some nasty bug or have a cool feature request? [Just open a new issue](https://github.com/nicoespeon/gitgraph.js/issues).
Please have a look at [the Issue Guidelines](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) from [Nicolas Gallagher](https://github.com/necolas) before doing so.
## Documentation
The JavaScript source code is documented with [JSDoc](http://usejsdoc.org/).
## Contributing
Editor preferences are available in [the editor config](https://github.com/nicoespeon/gitgraph.js/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at .
The project uses [Grunt](http://gruntjs.com) with convenient methods for our workflow. It's how we lint our code, run tests, generate documentation, etc. To use it, install the required dependencies as directed and then run the following Grunt commands.
### Install Grunt
From the command line:
- Install `grunt-cli` globally with `npm install -g grunt-cli`.
- Install [the necessary local dependencies](https://github.com/nicoespeon/gitgraph.js/blob/master/.editorconfig) with `npm install`.
When completed, you'll be able to run the various Grunt commands provided from the command line.
[> Need more information about how to get started with Grunt?](http://gruntjs.com/getting-started)
### Available Grunt commands
#### test code - `grunt test`
Check source code against [JSHint](http://www.jshint.com/) then runs unit tests with [Jasmine](http://pivotal.github.io/jasmine/).
#### generate documentation - `grunt doc`
Generate source code documentation into `dist/docs/` (not versioned) with [JSDoc](http://usejsdoc.org/).
#### compile a non-versioned release - `grunt dist`
Clean `dist/` directory, lint code, output the minified release into `dist/gitgraph.min.js` and generate the documentation into `dist/docs/`.
#### compile a new release - `grunt release`
Lint code, output the source and minified releases into `build/` and generate the official documentation into `docs/`.
#### open a live reload server - `grunt server`
For a better code experience, this grunt task opens a live server in your favorite browser. This server is automatically reloaded when you save a project file.
Please note that `examples/index.html` is the default file for testing ;)
## Versioning
We use [SemVer](http://semver.org/) as a guideline for our versioning here.
### What does that mean?
Releases will be numbered with the following format:
```
..
```
And constructed with the following guidelines:
- Breaking backward compatibility bumps the `` (and resets the `` and ``)
- New additions without breaking backward compatibility bumps the `` (and resets the ``)
- Bug fixes and misc. changes bumps the ``
## Authors and contributors
**Nicolas Carlo** - [@nicoespeon](https://twitter.com/nicoespeon) }
**Fabien Bernard** - [@fabien0102](https://twitter.com/fabien0102)
## Copyright and License
Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under [the MIT license](https://github.com/nicoespeon/gitgraph.js/blob/master/LICENSE.md).
[> What does that mean?](http://choosealicense.com/licenses/mit/)