Welcome to the Architecture Decision Records (ADRs) repository for the Financial Components stream of the Application Modernization Program (AMP) in the Information Services Divison (ISD) of the Ministry of Social Development and Poverty Reduction (SDPR) for the Government of British Columbia.
This repository contains all the architectural decisions made during the development of the Financial Components. ADRs help us document significant decisions that shape our project.
ADRs are automatically published to our Log4brains architecture knowledge base:
🔗 Financial Components ADRs Knowledge Base
Please use this link to browse and read the ADRs.
- Node.js: Ensure you have Node.js installed. Download it from nodejs.org.
- Log4brains: Install Log4brains globally if you haven't already.
npm install -g log4brainsTo preview the ADRs locally with hot-reloading enabled:
log4brains previewIn preview mode, any changes you make to a markdown file are automatically reflected in the UI.
To create a new ADR interactively:
log4brains adr newFollow the prompts to fill in the details of your ADR.
We welcome contributions from all team members. To contribute:
1. Clone the Repository
git clone https://github.com/kiiskila-bcgov/fc-madr.git2. Navigate to the Repository
cd fc-madr3. Create a New Branch
git checkout -b your-branch-nameReplace your-branch-name with a descriptive name for your branch.
4. Make Changes
- Add or edit ADRs using Log4brains.
- Follow the MADR template located in docs/decisions.
5. Commit Your Changes
git add .
git commit -m "Add ADR for [decision title]"6. Push to GitHub
git push origin your-branch-name7. Create a Pull Request
- Go to the repository on GitHub.
- Click on "Compare & pull request".
- Provide a description of your changes and submit the pull request.