/patterns

A collection of conventions, best practices, and design patterns favoured by the BiggerPockets Engineering team

Primary LanguageHTMLMIT LicenseMIT

Patterns

This is a collection of guidelines and style guide rules that we follow when writing software at BiggerPockets. Use these to guide implementation and reference them during peer review.

Contributing

To propose a new rule, or a change to an existing rule, open a Pull Request that includes the changes in a markdown-formatted file. Request review by the BiggerPockets/engineering team. Also post an announcement in the #engineers channel in Slack.

Try to follow the same format as existing rule files.

To test the Jekyll site locally run:

bundle exec jekyll serve