So in love with blau that you just want to contribute to our website? Start reading this document and figure out how simple it is to get started!
Open an Issue to report any problems or improvements. Be sure to include some description to explain the problem/improvement.
To submit a new feature, make sure that changes are done to the source code. Follow our style guide and do not forget the tests and attach the along with the description.
Try to solve a problem for each pull request, this increases the chances of acceptance. When in doubt, open a new issue so we can answer you. Look existing issues for ideas or to see if a similar issue has already been submitted.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :)
First install Node.js for the build process.
Install all dependencies:
$ cd blau-site
$ npm installOnce you have the dependencies installed, run npm start. This will run the
main tasks described here.
After building your changes, run each one of the test: tasks described
here:
$ npm run test:complexity
$ npm run test:perf
$ npm run test:regression
$ npm run test:npmAnd evaluate all the results - if everything is OK, then submit a pull request.
It is intended to maintain this project under the Semantic Versioning guidelines. Releases will be numbered with the following format:
<major>.<minor>.<patch>
Help us keep this repo open and inclusive. Please read and follow our thoughts on Code of Conduct.
-
Blau Game Official Site source code is licensed under the MIT License.
-
Other stuff related to Blau Game itself - e.g. logo and visual identity - which are available in this repo are licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.
-
The Download on the App Store badge has All Rights Reserved to Apple Inc.
All contributions are assumed to be also licensed under the same.