Repo organization ADR

[widal001]

Summary

We’ve described HHS/simpler-grants-gov as a “monorepo” but there are currently several other HHS repositories that also store code and track work related to the SimplerGrants initiative:

• https://github.com/HHS/simpler-grants-gov
• https://github.com/HHS/grants-product-and-delivery
• https://github.com/HHS/simpler-grants-pdf-builder
• https://github.com/HHS/nofo-transformation
• https://github.com/HHS/simpler-grants-analysis-funnel

We should adopt a more formal strategy for organizing our work and code within the SimplerGrants initiative and ensure that each repository has a clear purpose and structure.

Options

There are many different ways we can organize our work into repos but they generally fall into the following buckets:

• Monorepo: All code and issues are migrated to HHS/simpler-grants-gov
• Workstream-based repos: Only maintain a few top-level repositories that combine multiple related services managed by the same workstream or team, e.g. one for work on Simpler.Grants.gov and one for work on SimplerNOFOs.
• Repo per service: Create separate repositories for subsets of the SimplerGrants architecture that can be maintained separately.

Decision Criteria

• Limited overhead: Minimize the amount of overhead required to manage code and track work related to the SimplerGrants initiative.
• Internal code reusability: We have the ability to reuse shared application logic across different components of our architecture.
• Internal infra reusability: We have the ability to reuse shared infrastructure across different components of our architecture.
• Open source reusability: Members of the open source community can reuse and extend parts of the SimplerGrants codebase or architecture for their own work.
• Separation of concerns: Teams working on various services within the SimplerGrants initiative can manage their code and work in ways that are loosely coupled with other parts of the SimplerGrants ecosystem.
• Centralized view: Program-level staff and leadership can monitor progress and track dependencies across the entire SimplerGrants initiative in a centralized way.
• Access control: We have fine-grained control over access to issues and other privileges in the code base.

Approvers

• @lucasmbrown-usds
• @mdragon

Acceptance criteria

• The approvers for this decision have been identified (ideally before work on the ADR starts)
• The ADR is created and stored in documentation/wiki/decisions/adr with status "Accepted"
• The ADR has been reviewed and approved by the approvers listed above
• The ADR satisfies requirements that are outlined in the ADR template
• Any follow-up tickets have been created (if necessary)

[widal001]

This is the associated change request in GitBook

[widal001]

Merged in the change request to close this.