These are some of the ways you can contribute to OS.js
- Open issues You can post any issues to Github
- New features Create a pull request or open a new issue if you have any ideas for new features
- Translating Language support is a bit lacking, so any help appreciated!
- Testing Things are always changing, and automated tests are not enough to ensure everything is working 100%.
- Documentation Found something in the documentation that does not seem right ?
- Commuinty Join in our Gitter chat room for fun- and tech talk!
You can also submit patches and questions directly to me via email, but using Github is preferred.
- Code style guide.
- Commit message style guide
- Github pull-requests guide
- Join the Testing team
- Join the Translation team
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
Commit the changes to your repository and push changes like normal. You can use grunt watch to automatically run tasks when you change files.
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