straw-hat-team / adr Goto Github PK
View Code? Open in Web Editor NEWArchitecture Decision Record (ADR)
Home Page: https://straw-hat-team.github.io/adr/
License: MIT License
Architecture Decision Record (ADR)
Home Page: https://straw-hat-team.github.io/adr/
License: MIT License
* You **MUST** use underscore to declare dynamic section of a path
* You **MAY** replace the dynamic section of a path following the previous
rules
[example | description | pointer to more information | …]
Chosen option: "[option 1]", because [justification. e.g., only option, which
meets k.o. criterion decision driver | which resolves force force | … | comes
out best (see below)].
We don't have misalignment configuring environments across applications, this is one of those that we don't need that much freedom, and nowadays most people end up doing the exact same thing
[PREFIX]_ENVIRONMENT
to all your application deployments[PREFIX]_ENVIRONMENT
MUST be one of the following values
Talk about React Components API:
setSomething
or filterSomething
and rather use onSetSomething
or onFilterSomething
Michael Nygard for all his work on Architecture Decision Records: https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
How should we come up with some tagging for an app that allows us to use it in places like Sentry, HTTP calls headers, or any other thing that would be important to know which version of the app actually caused the issue, maybe even give customer support teams more insights and have fullstory metadata optimized as well.
I am not sure, we should learn from others' good practices, here are some ideas so far of potential information.
my-website
d6cd1e2bd19e03a81132a23b2025920577f84e37
(commit sha) or v2.4.3
environment
potentially related to #21Bikeshedding about TLD for local development
.localhost
for local development DNS resolutionBe able to scan code and search for secrets statically
Improve CHANGELOG.md
maintains
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
We should add an environment variable that allows us to know the release version, either using git commit, version, or whatever we decide TBD, we use this to track the releases of the app, and be able to use that in tracing, logging, error reporters and so on
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.