A JavaScript library to draw pretty git graphs.
? Help! The project is looking for maintainers!
Getting started
GitGraph.js codebase is a monorepo. Packages are released under @gitgraph/* scope.
As a user, you're probably interested in one of the rendering libraries:
You'll find usage details in their README.
As a contributor, you might be interested in checking out gitgraph-core. It contains the core logic for rendering libraries to use.
Running the project locally
Pre-requisites:
Setting things up:
- Clone the repository:
git clone git@github.com:nicoespeon/gitgraph.js.git - Install dependencies:
yarn install - Bootstrap the project:
yarn run lerna bootstrap
Lerna will install dependencies of all packages and links any cross-dependencies.
Available root-level commands are detailed in package.json. You would usually need:
yarn testto run Jest unit tests (yarn test --watchfor watch mode)yarn developto start Storybook, watching for changes of all packages
You can also go to specific packages and run available commands detailed in their
package.json. For example, you couldcd packages/gitgraph-core/and runyarn test --watchto only run tests of this package.But root-level commands are more convenient!
Contributing
Contributing Guide
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to GitGraph.js.
Good First Issues
To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.
Versioning
We use SemVer as a guideline for our versioning here.
Releases use the following format:
<major>.<minor>.<patch>
- Breaking changes bump
<major>(and reset<minor>&<patch>) - Backward compatible changes bump
<minor>(and reset<patch>) - Bug fixes bump
<patch>
Authors and contributors
Nicolas Carlo - @nicoespeon / https://nicoespeon.com
Fabien Bernard - @fabien0102 / https://fabien0102.com
Copyright and License
Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under the MIT license.
Thanks
Thanks to Chromatic for providing the visual testing platform that help us catch visual regressions for the rendering libs.