-
Notifications
You must be signed in to change notification settings - Fork 10
Validation checklist
Suggested things to consider when you're working on an aspect of eRegulations or reviewing a story - feel free to add more.
Experimental branch expected data: when an experimental branch is created, it should have a relatively recent full copy of production data. This will be current as of the latest the data copy was manually refreshed to the dev environment, as of the date the experimental branch was created.
See also: special cases in reg parts in scope.
- The first section in part 400 is in the second subpart, not the first
- Orphan sections
- Reserved section - single
- Reserved sections - range
- Reserved subpart (42 part 438 subpart G)
- Subject groups (such as in part 433)
- Appendix to Subpart F of Part 441
- Tables
- Footnotes
- Formulas
- Multi-level indented paragraphs
- Federal Register items in sidebars, including groups
- Adding a new regulation citation to an FR link
- Adding a different FR link to the same group as an existing FR link, and ensuring that they both appear on the first one's regulation citation
- Switching groups that are assigned to FR links and verifying the citation sidebar displays
- Other supplemental content items in sidebars
- Sidebar empty states
- Resources associated with:
- Sections that no longer exist
- Sections outside of our scope
- A large number of associated locations, like 43 FR 2413 and 43 FR 45176
- Reserved sections that have resources
- Resources that don't have:
- Date (such as statute)
- Name (such as CIBs)
- Description
- "Jump to" part and section
- Enter weird characters (should only accept numbers)
- Enter section that doesn't exist
- Link to a specific section
- Link to a specific paragraph within a section
- Print mode
- History mode
- Search
- Highlights in regulation text search results
- Special characters in search queries:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~
- Links to regulation sections in search results
- Smaller screen size (such as low-resolution laptop screen)
- Bigger screen size
- Error pages (404, 500)
- Accessibility - keyboard navigation
- Accessibility - screenreader navigation
- Add or edit public link
- Add or edit Federal Register document
- Log in and out using Django authentication
- Log in and out using IDM
- Download existing item
- Admin panel: Upload and download new item
- File with long filename
- Large file (more than 5 mb) [not currently supported]
- File with tricky characters in filename, such as
\ /
- Admin panel: Delete item
- Admin panel: Edit item to add very long description and title, including Unicode characters
- Admin panel: Add lots of citations to an item, including citations that are out of scope for eRegs and shouldn't visibly display (like 42 CFR 3.404)
- Front end: View a list of all internal documents (go to a single subject and select internal documents, then clear that subject)
- Add, rename, remove subjects
- Site map (/sitemap.xml)
- API documentation page (/api/swagger/)
Please note that all pages on this GitHub wiki are draft working documents, not complete or polished.
Our software team puts non-sensitive technical documentation on this wiki to help us maintain a shared understanding of our work, including what we've done and why. As an open source project, this documentation is public in case anything in here is helpful to other teams, including anyone who may be interested in reusing our code for other projects.
For context, see the HHS Open Source Software plan (2016) and CMS Technical Reference Architecture section about Open Source Software, including Business Rule BR-OSS-13: "CMS-Released OSS Code Must Include Documentation Accessible to the Open Source Community".
For CMS staff and contractors: internal documentation on Enterprise Confluence (requires login).
- Federal policy structured data options
- Regulations
- Resources
- Statute
- Citation formats
- Export data
- 2021
- Reg content sources
- Default content view
- System last updated behavior
- Paragraph indenting
- Content authoring workflow
- Browser support
- Focus in left nav submenu
- Multiple content views
- Content review workflow
- Wayfinding while reading content
- Display of rules and NPRMs in sidebar
- Empty states for supplemental content
- 2022
- 2023
- 2024
- Medicaid and CHIP regulations user experience
- Initial pilot research outline
- Comparative analysis
- Statute research
- Usability study SOP
- 2021
- 2022
- 2023-2024: 🔒 Dovetail (requires login)
- 🔒 Overview (requires login)
- Authentication and authorization
- Frontend caching
- Validation checklist
- Search
- Security tools
- Tests and linting
- Archive