Deploying to gh-pages from @ 58dcfff 🚀

adr/_next/data/tHJY9LKvrdlwuYJiojHVN/adr/20240926-transition-to-simplified-git-flow.json

@@ -0,0 +1 @@
+{"pageProps":{"projectName":"Log4brains","currentAdr":{"slug":"20240926-transition-to-simplified-git-flow","package":null,"title":"Transition to Simplified Git Flow","status":"draft","supersededBy":null,"tags":[],"deciders":[],"body":{"enhancedMdx":"\n## Context and Problem Statement\n\nThe existing GitHub Flow process lacked clarity for stable releases and was overly manual, making it hard to delegate and streamline contributions. The need was for a more structured yet simple workflow that would facilitate testing and contributions while automating releases.\n\nAdditional context in [Discussion #108: Does this project need a new maintainer?](https://github.com/thomvaill/log4brains/discussions/108)\n\n## Decision Drivers\n\n- Need for automation in releases.\n- Be able to merge more quickly whithout breaking the stable branch, while making it possible for beta testers to test the new features.\n- Easier delegation to new maintainers.\n- Simplified yet structured process for contributors.\n- Clearer separation between ongoing development and stable releases.\n\n## Considered Options\n\n- Continue with GitHub Flow.\n- Transition to Simplified Git Flow.\n- Full Git Flow with release branches.\n\n## Decision Outcome\n\nChosen option: **Simplified Git Flow**, because it provides structure (separating development from stable releases) without excessive complexity. It also allows for automated canary/beta releases and easier delegation for merging feature branches to `develop`.\n\n### Positive Consequences\n\n- Clear separation of development (`develop`) and stable (`stable`) branches.\n- Automated beta releases from `develop` to facilitate early testing.\n- Allows contributors to participate in testing beta features and reduces the manual overhead of testing and releasing stable versions\n- Easier to delegate responsibilities (Canary vs. Core Maintainers, see [CONTRIBUTING.md](CONTRIBUTING.md)).\n- More streamlined versioning via Conventional Commits.\n\n### Negative Consequences\n\n- Contributors need to adjust to using `develop` for PRs instead of `stable`.\n- Slight learning curve for Conventional Commits.\n\n## Pros and Cons of the Options\n\n### Continue with GitHub Flow\n\n- Good, because it’s simpler with fewer branches.\n- Bad, because it lacks separation of development and stable code.\n- Bad, because manual testing and release increase bottlenecks.\n\n### Simplified Git Flow\n\n- Good, because it balances structure with simplicity.\n- Good, because it allows easier delegation to maintainers.\n- Bad, because it introduces a new `develop` branch, which may need adjustment for contributors.\n\n### Full Git Flow\n\n- Good, because it provides a full release management process.\n- Bad, because it adds unnecessary complexity for smaller open-source projects.\n"},"creationDate":"2024-10-28T10:13:28.000Z","lastEditDate":"2024-10-28T10:13:28.000Z","lastEditAuthor":"Thomas Vaillant","publicationDate":"2024-09-26T21:59:59.000Z","file":{"relativePath":"docs/adr/20240926-transition-to-simplified-git-flow.md","absolutePath":"/home/runner/work/log4brains/log4brains/docs/adr/20240926-transition-to-simplified-git-flow.md"},"repository":{"provider":"github","viewUrl":"https://github.com/thomvaill/log4brains/blob/master/docs/adr/20240926-transition-to-simplified-git-flow.md"}},"l4bVersion":""},"__N_SSG":true}

adr/_next/data/Xiz7EPOkFFzr84I2yvxGG/index.json → adr/_next/data/tHJY9LKvrdlwuYJiojHVN/index.json

@@ -1 +1 @@
-{"pageProps":{"projectName":"Log4brains","adrs":[{"slug":"20200924-use-markdown-architectural-decision-records","package":null,"title":"Use Markdown Architectural Decision Records","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-24T21:59:59.000Z"},{"slug":"20200925-multi-packages-architecture-in-a-monorepo-with-yarn-and-lerna","package":null,"title":"Multi-packages architecture in a monorepo with Yarn and Lerna","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-25T21:59:59.000Z"},{"slug":"web/20200925-use-nextjs-for-static-site-generation","package":"web","title":"Use Next.js for Static Site Generation","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-25T21:59:59.000Z"},{"slug":"20200925-use-prettier-eslint-airbnb-for-the-code-style","package":null,"title":"Use Prettier-ESLint Airbnb for the code style","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-25T21:59:59.000Z"},{"slug":"web/20200926-react-file-structure-organized-by-feature","package":"web","title":"React file structure organized by feature","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-26T21:59:59.000Z"},{"slug":"20200926-use-the-adr-number-as-its-unique-id","package":null,"title":"Use the ADR number as its unique ID","status":"superseded","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-26T21:59:59.000Z"},{"slug":"20200927-avoid-default-exports","package":null,"title":"Avoid default exports","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-27T21:59:59.000Z"},{"slug":"web/20200927-avoid-react-fc-type","package":"web","title":"Avoid React.FC type","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-27T21:59:59.000Z"},{"slug":"web/20200927-use-react-hooks","package":"web","title":"Use React hooks","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-27T21:59:59.000Z"},{"slug":"core/20201002-use-explicit-architecture-and-ddd-for-the-core-api","package":"core","title":"Use Explicit Architecture and DDD for the core API","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-02T21:59:59.000Z"},{"slug":"core/20201003-markdown-parsing-is-part-of-the-domain","package":"core","title":"Markdown parsing is part of the domain","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-03T21:59:59.000Z"},{"slug":"web/20201007-next-js-persistent-layout-pattern","package":"web","title":"Next.js persistent layout pattern","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-07T21:59:59.000Z"},{"slug":"20201016-use-the-adr-slug-as-its-unique-id","package":null,"title":"Use the ADR slug as its unique ID","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-16T21:59:59.000Z"},{"slug":"20201026-the-core-api-is-responsible-for-enhancing-the-adr-markdown-body-with-mdx","package":null,"title":"The core API is responsible for enhancing the ADR markdown body with MDX","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-26T22:59:59.000Z"},{"slug":"core/20201027-adr-link-resolver-in-the-domain","package":"core","title":"ADR link resolver in the domain","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-27T22:59:59.000Z"},{"slug":"20201103-use-lunr-for-search","package":null,"title":"Use Lunr for search","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-11-03T22:59:59.000Z"},{"slug":"20210113-distribute-log4brains-as-a-global-npm-package","package":null,"title":"Distribute Log4brains as a global NPM package","status":"accepted","creationDate":"2021-01-13T17:48:47.000Z","publicationDate":"2021-01-13T22:59:59.000Z"}],"markdown":"<!-- This file is the homepage of your Log4brains knowledge base. You are free to edit it as you want -->\n\n# Architecture knowledge base\n\nWelcome 👋 to the architecture knowledge base of Log4brains.\nYou will find here all the Architecture Decision Records (ADR) of the project.\n\n## Definition and purpose\n\n> An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant.\n> An Architectural Decision Record (ADR) captures a single AD, such as often done when writing personal notes or meeting minutes; the collection of ADRs created and maintained in a project constitutes its decision log.\n\nAn ADR is immutable: only its status can change (i.e., become deprecated or superseded). That way, you can become familiar with the whole project history just by reading its decision log in chronological order.\nMoreover, maintaining this documentation aims at:\n\n- 🚀 Improving and speeding up the onboarding of a new team member\n- 🔭 Avoiding blind acceptance/reversal of a past decision (cf [Michael Nygard's famous article on ADRs](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions.html))\n- 🤝 Formalizing the decision process of the team\n\n## Usage\n\nThis website is automatically updated after a change on the `master` branch of the project's Git repository.\nIn fact, the developers manage this documentation directly with markdown files located next to their code, so it is more convenient for them to keep it up-to-date.\nYou can browse the ADRs by using the left menu or the search bar.\n\nThe typical workflow of an ADR is the following:\n\n![ADR workflow](/l4b-static/adr-workflow.png)\n\nThe decision process is entirely collaborative and backed by pull requests.\n\n## More information\n\n- [Log4brains documentation](https://github.com/thomvaill/log4brains/tree/master#readme)\n- [What is an ADR and why should you use them](https://github.com/thomvaill/log4brains/tree/master#-what-is-an-adr-and-why-should-you-use-them)\n- [ADR GitHub organization](https://adr.github.io/)\n","l4bVersion":""},"__N_SSG":true}
+{"pageProps":{"projectName":"Log4brains","adrs":[{"slug":"20200924-use-markdown-architectural-decision-records","package":null,"title":"Use Markdown Architectural Decision Records","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-24T21:59:59.000Z"},{"slug":"20200925-multi-packages-architecture-in-a-monorepo-with-yarn-and-lerna","package":null,"title":"Multi-packages architecture in a monorepo with Yarn and Lerna","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-25T21:59:59.000Z"},{"slug":"web/20200925-use-nextjs-for-static-site-generation","package":"web","title":"Use Next.js for Static Site Generation","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-25T21:59:59.000Z"},{"slug":"20200925-use-prettier-eslint-airbnb-for-the-code-style","package":null,"title":"Use Prettier-ESLint Airbnb for the code style","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-25T21:59:59.000Z"},{"slug":"web/20200926-react-file-structure-organized-by-feature","package":"web","title":"React file structure organized by feature","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-26T21:59:59.000Z"},{"slug":"20200926-use-the-adr-number-as-its-unique-id","package":null,"title":"Use the ADR number as its unique ID","status":"superseded","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-26T21:59:59.000Z"},{"slug":"20200927-avoid-default-exports","package":null,"title":"Avoid default exports","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-27T21:59:59.000Z"},{"slug":"web/20200927-avoid-react-fc-type","package":"web","title":"Avoid React.FC type","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-27T21:59:59.000Z"},{"slug":"web/20200927-use-react-hooks","package":"web","title":"Use React hooks","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-09-27T21:59:59.000Z"},{"slug":"core/20201002-use-explicit-architecture-and-ddd-for-the-core-api","package":"core","title":"Use Explicit Architecture and DDD for the core API","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-02T21:59:59.000Z"},{"slug":"core/20201003-markdown-parsing-is-part-of-the-domain","package":"core","title":"Markdown parsing is part of the domain","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-03T21:59:59.000Z"},{"slug":"web/20201007-next-js-persistent-layout-pattern","package":"web","title":"Next.js persistent layout pattern","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-07T21:59:59.000Z"},{"slug":"20201016-use-the-adr-slug-as-its-unique-id","package":null,"title":"Use the ADR slug as its unique ID","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-16T21:59:59.000Z"},{"slug":"20201026-the-core-api-is-responsible-for-enhancing-the-adr-markdown-body-with-mdx","package":null,"title":"The core API is responsible for enhancing the ADR markdown body with MDX","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-26T22:59:59.000Z"},{"slug":"core/20201027-adr-link-resolver-in-the-domain","package":"core","title":"ADR link resolver in the domain","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-10-27T22:59:59.000Z"},{"slug":"20201103-use-lunr-for-search","package":null,"title":"Use Lunr for search","status":"accepted","creationDate":"2020-09-25T16:34:23.000Z","publicationDate":"2020-11-03T22:59:59.000Z"},{"slug":"20210113-distribute-log4brains-as-a-global-npm-package","package":null,"title":"Distribute Log4brains as a global NPM package","status":"accepted","creationDate":"2021-01-13T17:48:47.000Z","publicationDate":"2021-01-13T22:59:59.000Z"},{"slug":"20240926-transition-to-simplified-git-flow","package":null,"title":"Transition to Simplified Git Flow","status":"draft","creationDate":"2024-10-28T10:13:28.000Z","publicationDate":"2024-09-26T21:59:59.000Z"}],"markdown":"<!-- This file is the homepage of your Log4brains knowledge base. You are free to edit it as you want -->\n\n# Architecture knowledge base\n\nWelcome 👋 to the architecture knowledge base of Log4brains.\nYou will find here all the Architecture Decision Records (ADR) of the project.\n\n## Definition and purpose\n\n> An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant.\n> An Architectural Decision Record (ADR) captures a single AD, such as often done when writing personal notes or meeting minutes; the collection of ADRs created and maintained in a project constitutes its decision log.\n\nAn ADR is immutable: only its status can change (i.e., become deprecated or superseded). That way, you can become familiar with the whole project history just by reading its decision log in chronological order.\nMoreover, maintaining this documentation aims at:\n\n- 🚀 Improving and speeding up the onboarding of a new team member\n- 🔭 Avoiding blind acceptance/reversal of a past decision (cf [Michael Nygard's famous article on ADRs](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions.html))\n- 🤝 Formalizing the decision process of the team\n\n## Usage\n\nThis website is automatically updated after a change on the `develop` branch of the project's Git repository, from the latest beta version of Log4brains.\nIn fact, the developers manage this documentation directly with markdown files located next to their code, so it is more convenient for them to keep it up-to-date.\nYou can browse the ADRs by using the left menu or the search bar.\n\nThe typical workflow of an ADR is the following:\n\n![ADR workflow](/l4b-static/adr-workflow.png)\n\nThe decision process is entirely collaborative and backed by pull requests.\n\n## More information\n\n- [Log4brains documentation](https://github.com/thomvaill/log4brains/tree/develop#readme)\n- [What is an ADR and why should you use them](https://github.com/thomvaill/log4brains/tree/develop#-what-is-an-adr-and-why-should-you-use-them)\n- [ADR GitHub organization](https://adr.github.io/)\n","l4bVersion":""},"__N_SSG":true}