Skip to content

dwp/cms-options-prototype

Repository files navigation

cms-options

Design prototypes for Child Maintenance Service 'Options' service, AKA: Get help arranging child maintenance.

Hierarchy

Maintain good folder hierarchy to ensure future iterations are easily navigable. As follows:

- /app/views/prototype(number)/iteration(number)

Dynamic text for an iteration is stored under app/view/prototype(number)/iteration(number)/includes

All prototypes with more than a single iteration should have an index under app/view/prototype(number) called index.html

Routing

Separate routes files are maintained for each iteration for the prototype.

1. Add new routes files to app/routes using consistent naming principles, eg - prototype(number)iteration(number).js

2. Update the master routes file at app/routes.js with the const name, filepath and router use (see the file, it's pretty self-explanatory)

Versioning

For each new iteration complete the following steps:

1. It is recommended this is done under a branch in case of a breaking change

2. Create new prototype and/or iteration in folder structure as described under # Hierarchy

3. Create new routes file as described under # Routing

4. Update master routes file as described under # Routing

5. Update views/index.html with:

  a) a new or amended accordion_section, if appropriate

  b) an updated 'Latest version' link

6. Add new or amended version index file as described under # Hierarchy

Merging

I recommend (although it's not enforced) that work is undertaken in feature branches with regular commits rather than direct commits to Master.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages