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 is appreciated! Join the Translation team
- Testing Things are always changing, and automated tests are not enough to ensure everything is working 100%. Join the Testing team
- Documentation Found something in the homepage or documentation that does not seem right?
- Community 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.
To get started you need a Github account.
Then proceed to fork OS.js via the official project page.
Follow the official documentation on how to install and run OS.js, with one exception -- run the development server instead:
./bin/start-node-dev.sh
- Fork OS.js on github
- Follow the style guide
- Use UTF-8 file encoding
- I strongly recommend using a separate branch for your changes.
- I strongly recommend squashing your commits if you have spread out a task into several pieces.
- Make sure you test all your changes before commiting so it does not lead to extra commits with corrections.
- Keep your commit messages as short as possible and don't include filenames. Write a short description of what was done, not where. Example: "Themes: Corrected colors" or "Locales: Added ru_RU locales"
- Send a pull-request when you are done
- Keep your fork up-to-date
Tip: Have grunt watch running in the background to automatically run tasks for you when something changes.
Tip: Run grunt jscs jshint to check for syntax problems and style guide violations
Tip: Run grunt mochaTest to run server-side checks
Tip: Run grunt test to test everything
NOTE THAT I DO NOT ACCEPT PULL-REQUESTS THAT DO NOT FOLLOW THE GUIDELINES ABOVE (AS OF 2016)