|
1 | | -## Filing an issue |
2 | | - |
3 | | -Before filing an issue, please [search the queue](https://github.com/c3js/c3/issues) to make sure it hasn't already been reported. |
4 | | - |
5 | | -If a bug, please include the following — |
6 | | - |
7 | | -1. What version of C3? |
8 | | -1. What browsers have you confirmed it in? |
9 | | -1. Can you isolate the issue by providing a jsFiddle demonstrating it in a minimalist capacity? |
10 | | - |
11 | | -Please *do not* ask for support using the issue queue. For support, please ask [on chat](https://gitter.im/c3js/c3) or [the mailing list](groups.google.com/forum/#!forum/c3js). |
12 | | - |
13 | | -##Building C3 from sources |
14 | | - |
15 | | - 1. **Clone the repo from GitHub** |
16 | | - |
17 | | - git clone https://github.com/c3js/c3.git |
18 | | - cd c3 |
19 | | - |
20 | | - 2. **Acquire build dependencies.** Make sure you have [Node.js](http://nodejs.org/) installed on your workstation. This is only needed to _build_ C3 from sources. C3 itself has no dependency on Node.js once it is built. Now run: |
21 | | - |
22 | | - npm install -g grunt-cli |
23 | | - npm install |
24 | | - |
25 | | - The first `npm` command sets up the popular [Grunt](http://gruntjs.com/) build tool. You might need to run this command with `sudo` if you're on Linux or Mac OS X, or in an Administrator command prompt on Windows. The second `npm` command fetches the remaining build dependencies. |
26 | | - |
27 | | - 3. **Run the build tool** |
28 | | - |
29 | | - grunt |
30 | | - |
31 | | - Now you'll find the built files in `c3.js`, `c3.min.js`, `c3.css` & `c3.min.css`. |
32 | | - |
33 | | -## Running the tests |
34 | | -The `grunt` script will automatically run the specification suite and report its results. |
35 | | - |
36 | | -Or, if you want to run the specs in a browser (e.g., for debugging), simply open `spec/runner.html` in your browser. |
37 | | - |
38 | | -## Contributing your changes |
39 | | - |
40 | | -Add something about PRs here, indicate that PRs should not bump the version number & the build output files (`c3.js`, `c3.min.js`, `c3.css` & `c3.min.css`) should be excluded |
| 1 | +# How to contribute to billboard.js |
| 2 | +billboard.js is opened to everyone and we're welcoming for any kind of contribution. |
| 3 | +We believe that our project can grow with your interests helping others' necessities. |
| 4 | + |
| 5 | +## Style Guide |
| 6 | + |
| 7 | +billboard.js has several style guidelines to follow. |
| 8 | +Before your start, please read attentively below instructions. |
| 9 | + |
| 10 | +### Linting and Code Convention |
| 11 | +To maintain the code style, we adopted [ESLint](http://eslint.org/) to maintain our code quality. |
| 12 | +The [rules](https://github.com/naver/eslint-config-naver/tree/master/rules) are modified version based on [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript). |
| 13 | + |
| 14 | +### Commit Log Guidelines |
| 15 | +billboard.js use formatted commit logs for many different purposes (like creating CHANGELOG, ease history searching, etc.). |
| 16 | +To not break, you'll be forced to follow our commit log guidelines. |
| 17 | +Before your commit/push, make sure following our commit log guidelines. |
| 18 | + |
| 19 | +The outline is as below: |
| 20 | +```bash |
| 21 | +<type>(<module>): <subject> |
| 22 | +<BLANK LINE> |
| 23 | +<body> |
| 24 | +<BLANK LINE> |
| 25 | +<footer> |
| 26 | +``` |
| 27 | + |
| 28 | +- **Types** |
| 29 | + - **feat**: A new feature |
| 30 | + - **fix**: A bug fix |
| 31 | + - **docs**: Documentation only changes |
| 32 | + - **style**: Changes that do not affect the meaning of the code. Such as white-space, formatting, missing semi-colons, etc. |
| 33 | + - **refactor**: A code change that neither fixes a bug nor adds a feature |
| 34 | + - **test**: Adding missing tests. Changing tests. |
| 35 | + - **chore**: Changes to the build process or tools and libraries such as documentation generation |
| 36 | + |
| 37 | +Example commit of fixing a bug: |
| 38 | +```bash |
| 39 | +Fix(Axis): Correct tick rendering |
| 40 | + |
| 41 | +Update condition of tick to avoide unnecessary tick rendering |
| 42 | + |
| 43 | +Ref #20 |
| 44 | +``` |
| 45 | + |
| 46 | +## How to submit Pull Requests |
| 47 | +Steps to submit your pull request: |
| 48 | + |
| 49 | +1. Fork `billboard.js` on your repository |
| 50 | +2. Create new branch from your billboard.js master branch (and be sure always to be up-to-date) |
| 51 | +3. Do your work |
| 52 | +4. Create test code for your work (when is possible) |
| 53 | +5. Run `npm run lint` for linting and code style check. (update until without any error or warnings) |
| 54 | +6. Run test code by `npm run test` or `npm run test:chrome` to run the test on chrome browser. |
| 55 | + Make sure tests are all passed at least in latest version of Chrome(mobile/desktop). |
| 56 | +7. Write commit log following convention and push to your repository branch. |
| 57 | +8. Create a new PR from your branch to billboard.js. |
| 58 | +9. Wait for reviews. |
| 59 | + When your contribution is well enough to be accepted, then will be merged to our branch. |
| 60 | +10. All done! |
| 61 | + |
| 62 | + |
| 63 | +## License |
| 64 | +By contributing to billboard.js, you're agreeing that your contributions will be licensed under its [MIT](https://opensource.org/licenses/MIT) license. |
0 commit comments