Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

53 lines (31 loc) · 1.77 KB

How to contribute

Want to help in the development in OS.js?

This document will explain how to submit changes.

If you have questions or suggestions you can also open an issue.

You can also submit patches and questions directly to me via email, but using Github is preferred.

Getting started

To get started you need a Github account.

Then proceed to fork OS.js via the official project page.

Clone your newly created repository (git) and build:

sudo npm install -g grunt-cli
npm install
grunt

Start the server and test if everything is working:

./bin/start-node-dev.sh

Making and submitting changes

Commit the changes to your repository and push changes like normal.

When you're done with the changes and want to submit your work, head over to the pull request page and click "New pull request".

Please note that you don't have to create a new pull-request if you make new changes to the branch you specified, github will update automatically

If you don't know how pull requests work, look at the documentation on Github.

Style guide

The code style guide is located in the wiki.

Make sure your commit messages are short and to the point.

Other resources