-
Notifications
You must be signed in to change notification settings - Fork 1
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
🏗♻️:future-proof architecture decision records #655
🏗♻️:future-proof architecture decision records #655
Conversation
66c329a
to
0ce2b02
Compare
Standford Libraries (Research support) had put out a PDF handout (linked below, from 2015ish) on the topic of “Best practices for file naming” — no longer an actual place to learn today, but they did a pretty good job of explaining w/ case studies and such… |
@DerekNonGeneric, suggest rfc{1123,3339} date format instead (?) |
0ce2b02
to
f98d9cc
Compare
There are some more choices i see rn as far as where the naming conventions may go: a. option b. (or similar) would allow us to alleviate the content burden in option d. would allow for an entry specifically for the ADRs authoring guidance 👍 |
this PR should land tonight — within the hour, hopefully. |
66dc131
to
24f538f
Compare
doc/collections/_adrs/0003-decision-to-use-build-dir-dist-subdir.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm, modulo corrections mentioned, at the least.
doc/collections/_adrs/0003-decision-to-use-build-dir-dist-subdir.md
Outdated
Show resolved
Hide resolved
doc/collections/_adrs/0003-decision-to-use-build-dir-dist-subdir.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
…ir.md Co-authored-by: OpenINF Bot <132791922+openinfbot@users.noreply.github.com> Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
…ir.md Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
e0593f3
to
093d2ca
Compare
file extension. Superfluous details removed for conciseness. Signed-off-by: Derek Lewis <dereknongeneric@open.inf.is>
doc/collections/_adrs/0003--decision_for_build_dir_logic.jekyll
Outdated
Show resolved
Hide resolved
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
The filename conventions could use more padded 0s, stay tuned!
Pull Request Purpose
Make a selection on the purpose(s) of your changes.
This PR contains the following:
Testing
Have you included any tests in your submission?
tests)
Breaking Changes
Have you modified any aspect public API surface (i.e., caused breakage)?
necessary)
Description
A concise recap summarily detailing what all are the changes being made.
List of any relevant issue numbers: