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

ADR for front-end code quality tools #190

Merged
merged 9 commits into from
Jul 17, 2023

Conversation

daphnegold
Copy link
Contributor

@daphnegold daphnegold commented Jul 11, 2023

Summary

Fixes #102

Time to review: 10 mins

Context for reviewers

Describes decision for front-end code quality tooling. Assumes we are using the Next.js template repository, however, set of tooling is extensible to any solution we choose.

@daphnegold daphnegold added the draft Not yet ready for review label Jul 11, 2023
@daphnegold daphnegold force-pushed the daphnegold/issue-102-front-end-tools branch from 6448d33 to e27d087 Compare July 13, 2023 18:33
@daphnegold daphnegold force-pushed the daphnegold/issue-102-front-end-tools branch from e27d087 to 51a6eed Compare July 13, 2023 18:36
@daphnegold daphnegold marked this pull request as ready for review July 13, 2023 18:51
@daphnegold daphnegold removed the draft Not yet ready for review label Jul 13, 2023
@widal001 widal001 added docs: adr Architecture decision record ticket topic: frontend labels Jul 13, 2023
- **Enforces security:** Tooling should assist us in identifying security concerns and vulnerabilities.
- **Well-maintained:** We have a preference towards libraries that are widely adopted and have active maintainers.

## Options Considered
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to consider something like immutableJS to enforce immutability? i know there are lots of pros and cons to that!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be alongside Typescript? Typescript will add immutability functionality that we can use as we desire, and I think that's sufficient for now. I'd need to do a deeper dive into immutable.js to see if it offers something additional. I can add it to the documentation so it is tracked as an option.

Copy link
Contributor

@SammySteiner SammySteiner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for putting this together.
I wonder if we can update this in the future as we add more tools.

@daphnegold
Copy link
Contributor Author

This looks great, thanks for putting this together. I wonder if we can update this in the future as we add more tools.

Definitely, I think that's ideal as we iterate!

@daphnegold daphnegold merged commit 6016dc3 into main Jul 17, 2023
@daphnegold daphnegold deleted the daphnegold/issue-102-front-end-tools branch July 17, 2023 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: adr Architecture decision record ticket
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ADR]: Front-end Code Quality Tools
4 participants