Contributing

We are happy to accept contributions from the community to improve this project.

Setup

Go to https://trimble-oss.github.io/contribute/ and follow the instructions for getting access to GitHub
Clone the project: https://github.com/trimble-oss/website-modus-bootstrap.trimble.com
Install dependencies with npm install
Run npm run serve to run local server. (If fails to run you may need to install Autoprefixer globally with npm install -g autoprefixer)
The site will be available at http://localhost:4000/ and will auto update when you make any changes

Filenames Requirements: Lowercase (not Mixed Case)
Filenames Requirements: Separate words with dash/hyphen (not underscores or spaces)
File formats: Icons or logos ideally SVG (minified). Use https://jakearchibald.github.io/svgomg/ for minifying a single image.
File formats: Photos should never be in PNG24. A high quality JPEG is usually 1/4 of the size
Always specify alt="" for improved accessibility
Always specify height and width to images to improve page-rendering time (reduce repaints)
Always add loading="lazy" to images below the fold for native lazy-loading (not needed for images less than 4 KB)
Add the class img-fluid to images which are wider than 320 pixels so that they scale down on small screens such as iPhone 5/SE
PNG Bitmap images should be losslessly optimized with https://squoosh.app/
Image file size should never exceed 200 KB
Tip: Don't hotlink to images on external sites - images on other sites maybe removed, renamed or changed and it means an extra TLD/DNS round-trip

[ ] Run npm run test to check all JS, HTML, CSS, Markdown and links for errors. [ ] Follow the code style guide for the project