python-architecture-linter VS architecture_decision_record

I think I grossly oversold this thing because there's a lot of comments here asking for something.

I don't really have this concept written down anywhere like a number of other ideas I have. But, I guess the short version is, if I had to make an elevator pitch or something: No framework is a configuration (maybe "distro" in the linux sense) of concepts (maybe "packages" in the software sense). A concept is either something you might use a framework or library for (and usually it exists somewhere), or it is something you would want a linter to find, and it might even be something that you want to ensure was done correctly at code review. I think this last one is the most accurate idea of what a "concept" is.

Over time I have accumulated a small informal set of "packages" that can be implemented without a helper library in nearly the same amount of code as if you were to use that library anyway. The important part is that the running software doesn't depend on the third party code, but actually the developers depend on a rule book and anything that violates the rules should be treated the same as calling an third party package's API method that doesn't exist. In other words: the dependency remains entirely in concept-space, not disk space.

This link below is not "no framework" but it is something I wrote where you can see the result of "no framework thinking". The concepts are stole from people who are probably smarter than me, have decades of experience and written books on these topics. The only difference is instead of turning it into a library to depend on, it's turned into rules for humans (which I guess is also what the book authors originally did anyway). I combined them and made them into a "distro" and I called it "modular provider architecture" (not very engaging or entertaining, but it does what's on the label).

https://github.com/Incognito/python-architecture-linter/tree...

That text document is meant to be an example of how developers should write an application. By the way, it has a demo application here which does basically nothing:

https://github.com/Incognito/python-architecture-linter-demo...

It might be hard to see here because it's pretty silly example, but I managed a small/growing team of 3-5 developers who create over 15 different services following this pattern. They did end up using libraries to do things like send data to/from Kafka or a DB, but the Modular Provider Architecture's rules were always there.

Oh, by the way, that repo I linked to, https://github.com/Incognito/python-architecture-linter/ ... this is a proof of concept for a linter that could implement the "no framework" concept. It is a dev dependency of your project, meaning you have no production framework as a dependency. It is a tool that lets you configure "rules" for your project in the style of any linter you already know of. It's like a linter from hyperspace, you can "lint" rules like.... if a file is 3 levels deep, and depended on by methods anywhere in the project with the word "bob" in the method name name, but those methods don't have if-statements, and also the Afferent coupling of the module itself is less than 0.5 .... fail CI with an explanation why. It also has a feature for you to commit an exemption list.

I used this in my teams once I started managing multiple large teams, and I could do things like generate entire reports across all projects of these really complex metrics that most linters and tools aren't really set up for.

That code is in these files, sorry for the total mess, I was just hacking around and didn't really think of a nice way to structure the definition "API. My main goal was proving the concept.

>I've found myself manually writing code for finding things in python's AST but a tool like this would be much more succinct

Wow, I also am writing a tool for finding things in the Python AST: https://github.com/Incognito/python-architecture-linter

It does other things too, but one of the key features is reading the AST. It's a bit of a prototype but if you want to jam together on a project I'd be open to it.

I'm translating the Architecture Decision Record project to more languages. I'm seeking advice and guidance please: how are you all managing translations of git repos of content such as documentation and markdown files?

My experiments so far are here:

https://github.com/sixarm/locale-help

My work-in-progress is to create a top level directory `./locales`, then subdirectories per language using a ISO 639-1 two-letter language code, then content directories, for example:

./locales/en/hello/ (this is in English)

./locales/es/hola/ (this is in Español a.k.a. Spanish)

What do you use to track which content directories correspond to each other across languages?

The Architecture Decision Record repo is now mostly auto-translated into Spanish, French, Welsh, and Korean, in the top level directory `./locales`, using the program `slug-case` to help translate the markdown content file headlines into directory names:

https://github.com/joelparkerhenderson/architecture-decision-record

Link is https://github.com/joelparkerhenderson/architecture-decision...

Hi, article author here, we supplement our architecture diagrams with Architectural Decision Records (ADRs) https://github.com/joelparkerhenderson/architecture-decision... in the ADR we capture:

Architecture decision record by joelparkerhenderson

If anyone wants to see Polar in action on a GitHub issue, I'm experimenting with Polar on my Architecture Decision Record repo:

https://github.com/joelparkerhenderson/architecture-decision...

(I'm on the fence about the value of Polar for this kind of issue... see what you think)

This method is only slightly formalized as ADR (architecture decision record). What I personally like about templates that people share on the interned (https://github.com/joelparkerhenderson/architecture-decision-record) it that if force designed to actually consider cons of selected approach or honestly attempt to analyze alternatives.

The GitHub repo joelparkerhenderson/architecture-decision-record is a good source to get an overview of tools, articles and examples.

GitHub is prompting me to add a git successor to my open source repo, in case I die.

Do people here have advice about how to do this, or experience in doing it?

Any brainstorms about how to do it across all the related repos, orgs, etc., such as a will, or well-known file in the repo, that donates to a nonprofit, or foundation, etc.?

Here's the repo:

https://github.com/joelparkerhenderson/architecture-decision-record

Architecture Decision Records are a big help for teamwork. I have a bunch of notes and examples here, including from my time at ThoughtWorks with technology radars.

https://github.com/joelparkerhenderson/architecture-decision...

If you want to get started with ADR, I recommend looking at the repository, where you can find different ADR templates and examples of how to use them.