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

Refactor architectural-decision repo into multiple libraries #10

Open
cspray opened this issue Jun 17, 2024 · 0 comments
Open

Refactor architectural-decision repo into multiple libraries #10

cspray opened this issue Jun 17, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@cspray
Copy link
Owner

cspray commented Jun 17, 2024

Right now this repo has the following features:

  1. Allow a PHP Attribute to be an Architectural Decision Record through the docblock associated with it.
  2. Parse a codebase for the places where a given ADR Attribute is used
  3. Generate an XML document detailing all the information about found ADR Attribute and where they're used in the codebase.

Right now, the core feature provided by this library is (1). This feature requires this library to be autoloaded in non-dev contexts. However, features (2) and (3) are not strictly required and introduce external dependencies. Additionally, features (2) and (3) are more of a tool used outside of your application and should be able to be installed in a tools/ directory or in an entirely separate repo and still function correctly.

Features (2) and (3) of this library will be split into its own repo where we can more properly split up responsibilities to reduce the overall number of dependencies required by users implementing this library.

@cspray cspray self-assigned this Jun 17, 2024
@cspray cspray added the enhancement New feature or request label Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant