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

🏗♻️:future-proof architecture decision records #655

Merged
merged 19 commits into from
Jan 3, 2024

Conversation

DerekNonGeneric
Copy link
Member

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:

  • 🐞🔧 bugfixing (🐜/🦟/🐛/🦗/🐝 et al.)
  • 🆕🎏 implementation of new feature(s)
  • ♻️ refactoring(s)
  • 📄 documentation modification(s)
  • 🔮 other

Testing

Have you included any tests in your submission?

  • yes (bugfixes and features will not be merged without
    tests
    )
  • no

Breaking Changes

Have you modified any aspect public API surface (i.e., caused breakage)?

  • yes (breaking changes will not be merged unless
    necessary
    )
  • no

Description

A concise recap summarily detailing what all are the changes being made.

List of any relevant issue numbers:

@DerekNonGeneric DerekNonGeneric added documentation Improvements or additions to documentation wip Issues and PRs that are still a work in progress content Related to creating / editing content infrastructure markdown An issue or PR related to Markdown labels Dec 26, 2023
@DerekNonGeneric DerekNonGeneric requested a review from a team December 26, 2023 02:37
@DerekNonGeneric
Copy link
Member Author

DerekNonGeneric commented Dec 26, 2023

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…

image

@OpenINFbot
Copy link
Member

OpenINFbot commented Dec 27, 2023

@DerekNonGeneric, suggest rfc{1123,3339} date format instead (?)

@DerekNonGeneric
Copy link
Member Author

DerekNonGeneric commented Dec 27, 2023

There are some more choices i see rn as far as where the naming conventions may go:

a. README.txt as suggested above (but then you have non-licenses in a LICENSE dir)
b. ../collections/_docs/contributing/naming-conventions.md
c. ../collections/_docs/handbook/style/file-names.md
d. ../collections/_docs/contributing/authoring-adrs.md


option b. (or similar) would allow us to alleviate the content burden in CONTRIBUTING.md, so the contribution guidelines then become more of a multi-page experience; this would seem like actually our plan for licensing guidance into separate remix of the original…

option d. would allow for an entry specifically for the ADRs authoring guidance 👍

@DerekNonGeneric DerekNonGeneric marked this pull request as ready for review December 27, 2023 05:21
@DerekNonGeneric
Copy link
Member Author

this PR should land tonight — within the hour, hopefully.

@DerekNonGeneric DerekNonGeneric added the fast-track PRs that do not need to wait for 48 hours to land label Dec 27, 2023
@DerekNonGeneric DerekNonGeneric force-pushed the feat/future-proof-arch branch 2 times, most recently from 66dc131 to 24f538f Compare December 27, 2023 15:33
Copy link
Member Author

@DerekNonGeneric DerekNonGeneric left a 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.

@DerekNonGeneric DerekNonGeneric added discuss Issues opened for discussions and feedbacks accessibility Issues and PRs related to accessibility (WCAG, etc.) claimed labels Dec 27, 2023
DerekNonGeneric and others added 10 commits January 2, 2024 15:21
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>
DerekNonGeneric and others added 3 commits January 2, 2024 15:35
file extension. Superfluous details removed for conciseness.

Signed-off-by: Derek Lewis <dereknongeneric@open.inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is>
@DerekNonGeneric DerekNonGeneric merged commit 1f80364 into OpenINF:main Jan 3, 2024
4 checks passed
@DerekNonGeneric DerekNonGeneric removed documentation Improvements or additions to documentation wip Issues and PRs that are still a work in progress content Related to creating / editing content infrastructure discuss Issues opened for discussions and feedbacks accessibility Issues and PRs related to accessibility (WCAG, etc.) markdown An issue or PR related to Markdown claimed fast-track PRs that do not need to wait for 48 hours to land labels Jan 3, 2024
@DerekNonGeneric DerekNonGeneric deleted the feat/future-proof-arch branch January 15, 2024 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants