Skip to content
This repository was archived by the owner on Jul 13, 2024. It is now read-only.

Commit c47e4a0

Browse files
committed
Improve readability of markdown files as plaintext
When reading in a terminal, it's much nicer to have shorter line lengths
1 parent 6d06a3b commit c47e4a0

File tree

2 files changed

+66
-25
lines changed

2 files changed

+66
-25
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,41 @@ Glad to hear you'd like to help us improving the library. Here's the how-to!
77

88
Sounds nice! Please proceed as following:
99

10-
1. **Search for existing issues.** Sometimes, other folks may have reported the same issue and it'd be nice not to duplicate them.
11-
2. If possible, please **create an isolated and reproducible test case.** Make use of [jsFiddle](jsfiddle.net) - for instance - to share your isolated test cases. We won't hold it against you for feature requests, but a live [POC](http://en.wikipedia.org/wiki/Proof_of_concept) is sometimes easier to catch.
12-
3. **Share as much information as possible.** Include browser and version, version of gitgraph.js, etc. where appropriate. That can help us to reproduce the bug, if so.
10+
1. **Search for existing issues.** Sometimes, other folks may have reported the
11+
same issue and it'd be nice not to duplicate them.
12+
2. If possible, please **create an isolated and reproducible test case.** Make
13+
use of [jsFiddle](jsfiddle.net) - for instance - to share your isolated test
14+
cases. We won't hold it against you for feature requests, but a live [POC][]
15+
is sometimes easier to catch.
16+
[POC]: http://en.wikipedia.org/wiki/Proof_of_concept
17+
3. **Share as much information as possible.** Include browser and version,
18+
version of gitgraph.js, etc. where appropriate. That can help us to reproduce
19+
the bug, if so.
1320

1421
## Or wanna contribute to the code?
1522

1623
Github's Pull Request is a fantastic tool to contribute to the code.
1724

1825
Just keep in mind the following rules:
1926

20-
- Change must be done in `src/` files, eventually `test/` or `examples/`, that's all.
27+
- Change must be done in `src/` files, eventually `test/` or `examples/`, that's
28+
all.
2129
- You'd be nice not to pollute your pull request with unintended changes.
22-
- Pull requests should always be against the `develop` branch, never against `master` nor `gh-pages`.
30+
- Pull requests should always be against the `develop` branch, never against
31+
`master` nor `gh-pages`.
2332

24-
Once you send a Pull Request, your code will be check with [Travis CI](https://travis-ci.org/nicoespeon/gitgraph.js) to tell whether you break the build or not. The Travis test should pass before we accept any Pull Request.
33+
Once you send a Pull Request, your code will be checked with [Travis CI][] to
34+
tell whether you break the build or not. The Travis test should pass before we
35+
accept any Pull Request.
36+
[Travis CI]: https://travis-ci.org/nicoespeon/gitgraph.js
2537

2638
## Check about our coding standards
2739

28-
Please follow our coding standards as best as you can to keep consistency over code.
40+
Please follow our coding standards as best as you can to keep consistency over
41+
code.
2942

30-
The [.editorconfig](https://github.com/nicoespeon/gitgraph.js/blob/develop/.editorconfig) file should help you configure your IDE to do so.
43+
The [.editorconfig][] file should help you configure your IDE to do so.
44+
[.editorconfig]: https://github.com/nicoespeon/gitgraph.js/blob/develop/.editorconfig
3145

3246
### JS
3347

@@ -40,10 +54,14 @@ The [.editorconfig](https://github.com/nicoespeon/gitgraph.js/blob/develop/.edit
4054

4155
- Adhere to the (default) [CSScomb](http://csscomb.com/) property order
4256
- Multiple-line approach (one property and value per line)
43-
- Always a space after a property's colon (.e.g, `display: block;` and not `display:block;`)
57+
- Always a space after a property's colon (.e.g, `display: block;` and not
58+
`display:block;`)
4459
- End all lines with a semi-colon
4560
- For multiple, comma-separated selectors, place each selector on its own line
46-
- Attribute selectors, like `input[type="text"]`, should always wrap the attribute's value in double quotes, for consistency and safety (see [this blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks).
61+
- Attribute selectors, like `input[type="text"]`, should always wrap the
62+
attribute's value in double quotes, for consistency and safety (see [this blog
63+
post on unquoted attribute values][blog] that can lead to XSS attacks).
64+
[blog]: http://mathiasbynens.be/notes/unquoted-attribute-values
4765

4866
### HTML
4967

@@ -54,6 +72,8 @@ The [.editorconfig](https://github.com/nicoespeon/gitgraph.js/blob/develop/.edit
5472

5573
## License
5674

57-
By contributing your code, you agree to license your contribution under the terms of [the MIT license](https://github.com/nicoespeon/gitgraph.js/blob/master/LICENSE.md).
75+
By contributing your code, you agree to license your contribution under the
76+
terms of the [MIT license][]
77+
[MIT license]: https://github.com/nicoespeon/gitgraph.js/blob/master/LICENSE.md
5878

5979
[> What does that mean?](http://choosealicense.com/licenses/mit/)

README.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,52 +20,70 @@ Production files are available under the `build/` directory.
2020

2121
## Report a bug / Ask for a feature
2222

23-
You found some nasty bug or have a cool feature request? [Just open a new issue](https://github.com/nicoespeon/gitgraph.js/issues).
23+
You found some nasty bug or have a cool feature request? [Just open a new
24+
issue](https://github.com/nicoespeon/gitgraph.js/issues).
2425

25-
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.
26+
Please have a look at the [Issue Guidelines][] from [Nicolas Gallagher][] before
27+
doing so.
28+
[Issue Guidelines]: https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md
29+
[Nicolas Gallagher]: https://github.com/necolas
2630

2731
## Documentation
2832

2933
The JavaScript source code is documented with [JSDoc](http://usejsdoc.org/).
3034

3135
## Contributing
3236

33-
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 <http://editorconfig.org>.
37+
Editor preferences are available in for [the editor config][] easy use in common
38+
text editors. Read more and download plugins at <http://editorconfig.org>.
39+
[the editor config]: https://github.com/nicoespeon/gitgraph.js/blob/master/.editorconfig
3440

35-
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.
41+
The project uses [Grunt](http://gruntjs.com) with convenient methods for our
42+
workflow. It's how we lint our code, run tests, generate documentation, etc. To
43+
use it, install the required dependencies as directed and then run the following
44+
Grunt commands.
3645

3746
### Install Grunt
3847

3948
From the command line:
4049

4150
- Install `grunt-cli` globally with `npm install -g grunt-cli`.
42-
- Install [the necessary local dependencies](https://github.com/nicoespeon/gitgraph.js/blob/master/.editorconfig) with `npm install`.
51+
- Install [the necessary local dependencies][] with `npm install`.
52+
[the necessary local dependencies]: https://github.com/nicoespeon/gitgraph.js/blob/master/.editorconfig
4353

44-
When completed, you'll be able to run the various Grunt commands provided from the command line.
54+
When completed, you'll be able to run the various Grunt commands provided from
55+
the command line.
4556

4657
[> Need more information about how to get started with Grunt?](http://gruntjs.com/getting-started)
4758

4859
### Available Grunt commands
4960

5061
#### test code - `grunt test`
5162

52-
Check source code against [JSHint](http://www.jshint.com/) then runs unit tests with [Jasmine](https://jasmine.github.io/).
63+
Check source code against [JSHint][] then runs unit tests with [Jasmine][].
64+
[JSHint]: http://www.jshint.com/
65+
[Jasmine]: https://jasmine.github.io/
5366

5467
#### generate documentation - `grunt doc`
5568

56-
Generate source code documentation into `dist/docs/` (not versioned) with [JSDoc](http://usejsdoc.org/).
69+
Generate source code documentation into `dist/docs/` (not versioned) with
70+
[JSDoc](http://usejsdoc.org/).
5771

5872
#### compile a non-versioned release - `grunt dist`
5973

60-
Clean `dist/` directory, lint code, output the minified release into `dist/gitgraph.min.js` and generate the documentation into `dist/docs/`.
74+
Clean `dist/` directory, lint code, output the minified release into
75+
`dist/gitgraph.min.js` and generate the documentation into `dist/docs/`.
6176

6277
#### compile a new release - `grunt release`
6378

64-
Lint code, output the source and minified releases into `build/` and generate the official documentation into `docs/`.
79+
Lint code, output the source and minified releases into `build/` and generate
80+
the official documentation into `docs/`.
6581

6682
#### open a live reload server - `grunt server`
6783

68-
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.
84+
For a better code experience, this grunt task opens a live server in your
85+
favorite browser. This server is automatically reloaded when you save a project
86+
file.
6987

7088
Please note that `examples/index.html` is the default file for testing ;)
7189

@@ -83,8 +101,10 @@ Releases will be numbered with the following format:
83101

84102
And constructed with the following guidelines:
85103

86-
- Breaking backward compatibility bumps the `<major>` (and resets the `<minor>` and `<patch>`)
87-
- New additions without breaking backward compatibility bumps the `<minor>` (and resets the `<patch>`)
104+
- Breaking backward compatibility bumps the `<major>` (and resets the `<minor>`
105+
and `<patch>`)
106+
- New additions without breaking backward compatibility bumps the `<minor>` (and
107+
resets the `<patch>`)
88108
- Bug fixes and misc. changes bumps the `<patch>`
89109

90110
## Authors and contributors
@@ -95,6 +115,7 @@ And constructed with the following guidelines:
95115

96116
## Copyright and License
97117

98-
Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under [the MIT license](https://github.com/nicoespeon/gitgraph.js/blob/master/LICENSE.md).
118+
Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under the [MIT license][]
119+
[MIT license]: https://github.com/nicoespeon/gitgraph.js/blob/master/LICENSE.md
99120

100121
[> What does that mean?](http://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)