Before submitting a new issue, please consider the following:
- Search this repository for open or closed issues that may relate to your pull request.
- General questions should go to the Gitter channel instead of the issue tracker.
To help us get a better understanding of the issue you are submitting, please use the following outline.
For JavaScript the JSDoc format will be adhered to. The technical documentation will be generated using the
Node module jsdoc. This may be installed using npm install -g jsdoc.
Standardized JavaScript will be enforced using JSHint. If any rules need to be adjusted beyond the default ruleset they
will be added to the .jshintrc file after being vetted by the core team.
Development will always be done on a feature branch originating from the master branch.
An example of the workflow:
- Sync with master
git checkout master && git pull - Create new branch associated with user story or task title in lowercase snake format.
git checkout -b user_story_title - Work your magic...
- Check the current repository status
git status - Stage files to be committed using the appropriate commands
git add --all . - Commit your staged changes and associate it with the task number
git commit -m '[TG-##] commit message' - Once have finished the task and the code has been tested and reviewed merge back to the master branch
git checkout master && git pull && git merge user_story_title - After any conflicts have been resolved update the GitHub repository
git push origin master
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.