Skip to content

Commit ac23c28

Browse files
ErikGartnerErikGartner
committed
feat: Switched core foundation
1 parent 2f45e7d commit ac23c28

File tree

9 files changed

+381
-1320
lines changed

9 files changed

+381
-1320
lines changed

‎CONTRIBUTING.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to dTree
2+
3+
## Commiting
4+
Please follow these guidelines.
5+
6+
### Versioning
7+
dTree uses SemVer 2.0.0. That is the versioning is <MAJOR>.<MINOR>.<PATCH>.
8+
9+
### Commit Message Format
10+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
11+
format that includes a **type**, a **scope** and a **subject**:
12+
13+
```
14+
<type>(<scope>): <subject>
15+
<BLANK LINE>
16+
<body>
17+
<BLANK LINE>
18+
<footer>
19+
```
20+
21+
The **header** is mandatory and the **scope** of the header is optional.
22+
23+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
24+
to read on GitHub as well as in various git tools.
25+
26+
### Revert
27+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
28+
29+
### Type
30+
Must be one of the following:
31+
32+
* **feat**: A new feature
33+
* **fix**: A bug fix
34+
* **docs**: Documentation only changes
35+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
36+
semi-colons, etc)
37+
* **refactor**: A code change that neither fixes a bug nor adds a feature
38+
* **perf**: A code change that improves performance
39+
* **test**: Adding missing tests
40+
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
41+
generation
42+
43+
### Scope
44+
The scope could be anything specifying place of the commit change. For example `$location`,
45+
`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
46+
47+
### Subject
48+
The subject contains succinct description of the change:
49+
50+
* use the imperative, present tense: "change" not "changed" nor "changes"
51+
* don't capitalize first letter
52+
* no dot (.) at the end
53+
54+
### Body
55+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
56+
The body should include the motivation for the change and contrast this with previous behavior.
57+
58+
### Footer
59+
The footer should contain any information about **Breaking Changes** and is also the place to
60+
reference GitHub issues that this commit **Closes**.
61+
62+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
63+
64+
## Recognitions
65+
These guidelines are forked from Angular.

‎README.md‎

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,31 @@
1-
# dtree
1+
# dTree
2+
*A library for visualizing data trees with multiple parents built on top of D3.*
23

3-
A library for visualizing data trees built on top of D3.
4+
## Requirements
5+
To use the library the only dependency is that [D3](https://github.com/mbostock/d3) v3 is loaded first.
46

5-
[![Travis build status](http://img.shields.io/travis/ErikGartner/dtree.svg?style=flat)](https://travis-ci.org/ErikGartner/dtree)
6-
[![Code Climate](https://codeclimate.com/github/ErikGartner/dtree/badges/gpa.svg)](https://codeclimate.com/github/ErikGartner/dtree)
7-
[![Test Coverage](https://codeclimate.com/github/ErikGartner/dtree/badges/coverage.svg)](https://codeclimate.com/github/ErikGartner/dtree)
8-
[![Dependency Status](https://david-dm.org/ErikGartner/dtree.svg)](https://david-dm.org/ErikGartner/dtree)
9-
[![devDependency Status](https://david-dm.org/ErikGartner/dtree/dev-status.svg)](https://david-dm.org/ErikGartner/dtree#info=devDependencies)
7+
## Usage
8+
Just include the compiled file ```dTree.js```, it exposes a ```dTree``` variable.
9+
10+
To create a graph from data use the following command:
11+
```
12+
dTree.init("#target-continer", treeData, options);
13+
```
14+
15+
## Development
16+
To setup and build the library from scratch follow these steps:
17+
1. ```npm install --save-dev```
18+
2. ```npm run-script build```
19+
20+
A demo is avaible by running:
21+
```
22+
npm run-script demo
23+
```
24+
25+
## Contributions
26+
To make contributions please follow the contributions document.
27+
28+
## License
29+
The MIT License (MIT)
30+
31+
Copyright (c) 2015 Erik Gärtner

‎package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "dtree",
2+
"name": "dTree",
33
"version": "0.0.1",
44
"description": "A library for visualizing data trees built on top of D3.",
5-
"main": "dist/dtree.js",
5+
"main": "dist/dTree.js",
66
"scripts": {
77
"test": "gulp",
88
"test-browser": "gulp test-browser",
@@ -59,8 +59,8 @@
5959
"serve-static": "^1.0"
6060
},
6161
"babelBoilerplateOptions": {
62-
"entryFileName": "dtree",
63-
"mainVarName": "dtree",
62+
"entryFileName": "dTree",
63+
"mainVarName": "dTree",
6464
"mochaGlobals": [
6565
"stub",
6666
"spy",

0 commit comments

Comments
 (0)