Fork the repository with the "Fork" button on GitHub.
Clone your fork.
$ git clone https://github.com/yourusername/algebra.js.git
$ cd algebra.js
$ npm install
This will create a node_modules
directory in the current working directory.
Tests are written in Jasmine. The test files are located in the test
directory. If your tests fit into one of the current test file categories, just go ahead and add them there. Otherwise, you can create a new test file. It has to end in -spec.js
.
$ npm test
This will run the Jasmine tests and a lint check. Any errors from npm test
should be addressed before making a pull request.
If you're adding something completely new, it's probably best if you first create an issue to describe the feature you want to add so that it can be discussed.
If you're just fixing a bug or making a patch change, no need to create an issue; just jump straight to the pull request. If the bug you're fixing closes an open issue, be sure to include either in a commit or in the pull request description which issue is being fixed.
The documentation for this project is maintained at http://algebra.js.org. You can edit this page by checking out the gh-pages
branch.
$ git checkout gh-pages
You can then edit the project page in index.md
.
Commit your changes with a descriptive commit message. Ideally, include an example of what you fixed or added. This is a good example.
$ git commit
Push your changes to your fork.
$ git push
Go to your fork on GitHub. You'll see a "Pull Request" button.
Write a description of what you did and submit!