node-vegvesen is intended to be a public project that anyone can participate in. If you would like to add support for new functions, fix a bug, do performance optimization etc. please read this guide.
Fork, then clone the repo:
git clone git@github.com:your-username/node-vegvesen.git
Install it:
npm install
Make sure the tests pass:
npm test
Make your changes. Add tests for your changes (where it makes sense). Make sure the tests pass:
npm test
Push to your fork and submit a pull request.
At this point you're waiting on me to accept the request. I like to at least comment on pull requests within a week (and, typically, within 24 hours). I may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Write a good commit message
If you have any problems, please don't hesitate to contact me via github, or via e-mail