Pull Requests are always welcome. In order to eliminate duplication or loss of efforts it is advisable to first open an issue and communicate your intentions to the project maintainers.
When you do submit a Pull Request please make sure to update the files CHANGELOG.md
and the README.md
(section #Release History).
The project adheres to a specific set of styling rules and guidelines.
- The Javascript Style Guide Based on AirBnB's style guide. Applies to both front and back end codebases.
- The Node.js Style Guide which apply to both the back and front end since we use Browserify as our dependency manager for the frontend application. Take special notice of the Document Blocks section.
- It is advisable that you install a Live Linter and Editor Config on your editor to help you with catching styling and linting issues early on.
For the browserify frontend applications the sequence of preference for requiring Third-Party libraries is:
- NPM: Just use the
package.json
file to declare any dependencies available through NPM. - napa: The napa package is a helper for installing repos without a package.json with NPM.
- Bower Bower, the known package manager.
- Asset Keep Third Party lib as a tracked file inside the repository.
For Third Party style requirements (e.g. Bootstrap) use Bower.