HMDA Rule Spec

This project is a work in progress

Nothing presented in the issues or in this repo is a final product unless it is marked as such.

Description: The HMDA Rule Spec is a collection of HMDA Edits written in the brij-spec standard. The HMDA Rule Engine interprets these rules to validate a HMDA data file.

How to get this running or how to use it

The project requires NodeJS and brij-spec to validate the rules are written correctly.

Once you have NodeJS installed, use it to install brij-spec.

Install dependencies from the project root directory:

npm install

To validate if a JSON file is BRIJ compliant:

./node_modules/brij-spec/bin/brij-validate -f <path to JSON file>

Getting involved

For details on how to get involved, please first read our CONTRIBUTING guidelines. This project follows an adapted pull request workflow on top of GitHub, please consult the details before adding features to the project.

---

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy