GitGraph.js codebase is a monorepo. Packages are released under
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
Setting things up:
- Clone the repository:
git clone email@example.com:nicoespeon/gitgraph.js.git
- Install dependencies:
- 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 could
cd packages/gitgraph-core/and run
yarn test --watchto only run tests of this package.
But root-level commands are more convenient!
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.
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.
We use SemVer as a guideline for our versioning here.
Releases use the following format:
- Breaking changes bump
- Backward compatible changes bump
- Bug fixes bump
Authors and contributors
Copyright and License
Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under the MIT license.
Thanks to Chromatic for providing the visual testing platform that help us catch visual regressions for the rendering libs.