Fetching contributors…
Cannot retrieve contributors at this time
125 lines (93 sloc) 4.71 KB

Contributing to mark.js

These are the contributing guidelines of mark.js. If you are interested in contributing to the website of mark.js, please head over to the mark.js website contributing guidelines.

1. Issues

If you have a question, problem, feature request or found a bug please open an issue.

1.1 Questions, Problems and Bugs

For each issue please provide:

  • What kind of browser and version you are using
  • What kind of mark.js version you are using
  • A detailed description
  • The exact steps to reproduce (bugs and problems)
  • A fiddle that demonstrates your issue (if possible)

1.2 Feature Requests

Please provide the following information:

  • Your use case, why your enhancement is necessary
  • How to solve it in your opinion

2. Development

2.1 General

Requirements: NodeJS (including npm) and Bower installed.

Before you start developing, you should clone or download this repository and run:

$ bower install
$ npm install

Now you are ready to develop.

2.2 Source Code Documentation

JSDOC is being used as an API documentation generator. If you want to extend mark.js it might be helpful for you to view the documentation first, to learn more about the internal structure. Simply run:

$ grunt dist

and open the file ./build/doc/index.html.

2.3 ES6 (ES2015) Information

mark.js was developed in ECMAScript 6. But as most browsers don't fully support ES6 yet, it has only those features implemented that can be converted "locally" to ES5 using Babel without making a polyfill necessary. This means to forgo using generators, Set, Map, for...of loops etc..

2.4 Grunt Tasks

The project is using Grunt as a base, Karma as a task runner and Jasmine (with jasmine-jquery) as a testing framework.

Grunt task Description
dev For development. Will run test on file changes
dist Triggers compile, test and creates a JSDOC documentation
compile Generates all files in ./dist
lint Runs ESLint lint
test Runs the test, lint and creates test coverage

Note: Run tasks with $ grunt [task] (Replace "[task]" with the actual task name).

2.5 Pull Requests

Pull requests are very much appreciated! 👍

Please note the following things when doing a pull request:

  • If your pull request is implementing a feature, please open a new issue first. Therein we can discuss about it and determine if it brings a benefit
  • Do not change any version
  • Always include a test if possible. Please avoid referencing existing test files to keep flexibility
    • Add a new fixture (test/fixtures/)
    • Add a new spec (test/specs/)
  • Reference related issues in the pull request description
  • Describe your changes and why they are necessary (if not stated in referenced issues)
  • When changing something inside mark.js, please run $ grunt dist at the end to generate files in dist/
  • Make sure that you format code to fit the code style. If something isn't covered, please see existing code for orientation. The maximum line length for JavaScript files is 80 characters. You'll be notified if something is wrong with the code style when running $ grunt test or $ grunt dist
  • Pull requests will not be accepted if they worsen test coverage significantly. You can view test coverage in ./build/coverage/ after running $ grunt test

2.6 Contribution and License Agreement

If you contribute to this project, you are implicitly allowing your code to be distributed under this license. You are also implicitly verifying that all code is your original work.

Thank you for contributing!