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

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

Merged
Merged
Changes from all commits
Commits
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
26 changes: 20 additions & 6 deletions doc/collections/_adrs/0004--decision_for_tools_dir.jekyll
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
adr_name: ADR 0004
title: Adoption of a Dedicated Top-Level โ€œToolsโ€ Directory Convention in Codebase Layouts
date: 2024-01-26
status: Proposed
date: 2024-01-26T22-0800
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
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
Markdown lint rules & plugins not already available as packages via registry.

Our tools directory hierarchy may look similar to the diagram below.

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

OpenINFbot marked this conversation as resolved.
Show resolved Hide resolved
<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