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.

Sign up for GitHub

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

๐Ÿ“„๐Ÿ”ง๏ผšupdate adr 0004 w/ fine example usage #691

Merged
merged 15 commits into from
Jan 31, 2024
Merged

๐Ÿ“„๐Ÿ”ง๏ผšupdate adr 0004 w/ fine example usage #691

Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2ca365c
๐Ÿ“„๐Ÿ”ง๏ผšupdate adr 0004 w/ fine example usage
DerekNonGeneric Jan 30, 2024
6d307d0
rm affiliation of AI team mates
DerekNonGeneric Jan 31, 2024
d33f398
there should be a field for last revision
DerekNonGeneric Jan 31, 2024
35fe112
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
DerekNonGeneric Jan 31, 2024
dd908c3
๐Ÿ“„๐Ÿ”ง๏ผšupdate adr 0004 w/ fine example usage
DerekNonGeneric Jan 30, 2024
9ed34ec
rm affiliation of AI team mates
DerekNonGeneric Jan 31, 2024
e792da5
there should be a field for last revision
DerekNonGeneric Jan 31, 2024
6bdf018
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
DerekNonGeneric Jan 31, 2024
f0140a2
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
DerekNonGeneric Jan 31, 2024
dedb2fb
Merge branch 'amend/adr-004--custom-lint-rules' of https://github.comโ€ฆ
DerekNonGeneric Jan 31, 2024
bde0453
fix linkage of AI team mates
DerekNonGeneric Jan 31, 2024
2a54930
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
OpenINFbot Jan 31, 2024
026cc39
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
OpenINFbot Jan 31, 2024
1a46b70
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
OpenINFbot Jan 31, 2024
18cf016
Update doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
OpenINFbot Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
adr_name: ADR 0004
title: Adoption of a Dedicated Top-Level โ€œToolsโ€ Directory Convention in Codebase Layouts
date: 2024-01-26
status: Proposed
updated: 20240130T22-0800
status: Approved
---

## Problem Statement
Expand All @@ -14,8 +15,8 @@ the activities involved in project maintenance, development, and delivery.

<br />

**Inspiration**: [@OpenINF/ATeamGrimesAIv2][]
**Authors**: [@OpenINF/ATeamClaude][], [@OpenINF/ATeamDerekNonGeneric][], [@OpenINF/ATeamXsGrok][]
**Inspiration**: [@OpenINF/ATeamGrimesAI][]
**Authors**: [@OpenINF/ATeamClaude][], [@OpenINF/ATeamDerekNonGeneric][], [@OpenINF/ATeamGrok][]
**Editors**: [@OpenINF/ATeamGrammarly][]

<br /><br />
Expand Down Expand Up @@ -83,6 +84,19 @@ We have resolved to adopt the top-level โ€œtoolsโ€ directory convention in our
codebases to improve the organization, discoverability, and collaboration for
our delvings into the ever-growing SLOCs supporting/relating to tools & scripts.

One fine example of perfect usage of this directory would be to store custom
lint rules that are not already available as a package on the registry.

The subdirectory hierarchy would look similar to:

```dir
โ”œโ”€โ”€ ๐Ÿ“ tools
โ”‚ โ”œโ”€โ”€ ๐Ÿ“‚ remark-lint-rules
โ”‚ โ”‚ โ””โ”€โ”€ ๐Ÿ“œ no-not-use.mjs
โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ remark-plugins
โ”‚ โ””โ”€โ”€ ๐Ÿ“ฆ generic-directives
```

<br /><br />

## Results
Expand Down Expand Up @@ -117,8 +131,8 @@ unmaintainable.

[@OpenINF/ATeamClaude]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrammarly]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrimesAIv2]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamXsGrok]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrimesAI]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrok]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamDerekNonGeneric]: https://github.com/OpenINF/wg-a-team#persons-roster

<!-- Prior Art -->
Expand Down