Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write up decisions on package structure and JavaScript formats in v5 #26

Closed
2 tasks done
Tracked by #2639
36degrees opened this issue Jul 4, 2023 · 1 comment · Fixed by #28
Closed
2 tasks done
Tracked by #2639

Write up decisions on package structure and JavaScript formats in v5 #26

36degrees opened this issue Jul 4, 2023 · 1 comment · Fixed by #28
Assignees
Labels
Decision Record Recording an architecture decision that has been made

Comments

@36degrees
Copy link
Contributor

36degrees commented Jul 4, 2023

What

Write up a decision record that covers the structure of the published GOV.UK Frontend package in v5, including:

  • the flavours of JavaScript provided
  • directory structure
  • filenames and file extensions

The decision record should live in the architecture repo and follow the same format as the provided template.

Why

Writing up these decisions gives us a place to record the rationale, which will help our future selves when we want to understand why things are the way they are.

It will also ensure we're all on the same page in the short term, and aid us when reviewing code changes.

Finally, we can use it to communicate the upcoming changes to the rest of the team and to our users.

Who needs to work on this

Developers

Who needs to review this

Developers, Tech Writer?

Done when

  • Decision record written up
  • Decision record reviewed and merged
@36degrees 36degrees added the Decision Record Recording an architecture decision that has been made label Jul 4, 2023
@36degrees 36degrees moved this from Backlog 🗄 to In progress 📝 in GOV.UK Design System cycle board Jul 4, 2023
@36degrees 36degrees changed the title Write up decisions on package structure and JavaScript formats Write up decisions on package structure and JavaScript formats in v5 Jul 4, 2023
@36degrees
Copy link
Contributor Author

@claireashworth I've added 'tech writers' to the 'Who needs to review this?' but unsure if it's a good use of your time? I'll leave it up to you to decide how much you want to be involved – happy to chat about it if useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Decision Record Recording an architecture decision that has been made
Projects
2 participants