merge(#1): docs: core philosophy

docs: core philosophy

Author: 403-html

.github/workflows/on_merge.yml

@@ -0,0 +1,33 @@
+name: Update AUTHORS.md on merge
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run authors
+        run: yarn authors
+
+      - name: Check if AUTHORS.md has changed
+        id: check_changes
+        run: |
+          git diff --exit-code || echo "::set-output name=changed::true"
+
+      - name: Commit changes
+        if: steps.check_changes.outputs.changed == 'true'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add AUTHORS.md
+          git commit -m "docs: update AUTHORS.md"
+          git push

.gitignore

@@ -0,0 +1 @@
+node_modules

.husky/pre-commit

@@ -0,0 +1,2 @@
+yarn install
+yarn precommit

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*": ["yarn run pretty", "yarn run lint"]
+}

.markdownlintignore

@@ -0,0 +1,6 @@
+.husky/
+.lintstagedrc.json
+.markdownlintignore
+.prettier*
+node_modules/
+yarn.lock

.prettierignore

@@ -0,0 +1,11 @@
+.git/
+.husky/
+.markdownlintignore
+.prettierignore
+.vscode/
+dist/
+LICENSE
+node_modules/
+package-lock.json
+package.json
+yarn.lock

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 80,
+  "proseWrap": "always"
+}

CONTRIBUTION.md

@@ -0,0 +1,63 @@
+# Contribution and style guidelines
+
+Welcome to the contribution guidelines for the QA architecture handbook! We
+appreciate your interest in contributing to this project and helping us build a
+valuable resource for the community.
+
+## How to contribute
+
+To contribute to the QA architecture handbook, you can follow these steps:
+
+1. Fork the repository to your GitHub account.
+2. Clone the forked repository to your local machine.
+3. Create a new branch for your changes.
+4. Install the necessary dependencies (`yarn install`, it'll also setup
+   pre-commit hooks).
+5. Make your changes to the content.
+6. Commit your changes with a clear and descriptive commit message.
+   1. If pre-commit hooks fail, please address the issues raised by the checks.
+7. Push your changes to your forked repository.
+8. Create a pull request to the main repository.
+9. Wait for the maintainers to review your changes.
+
+## Contribution guidelines
+
+When contributing to the QA architecture handbook, please follow these
+guidelines:
+
+- **Be respectful**: Treat others with respect, kindness, and empathy. We
+  welcome contributions from all individuals.
+- **Be clear and concise**: Write clear and concise content that is easy to
+  understand and follow.
+- **Be informative**: Provide valuable insights, practical advice, and relevant
+  examples to enhance the content.
+- **Be consistent**: Follow the existing style and formatting guidelines to
+  maintain a cohesive structure.
+
+## Style guidelines
+
+To maintain consistency and readability across the handbook, please follow these
+style guidelines:
+
+- **Use headings and subheadings**: Organize the content with headings and
+  subheadings to create a clear hierarchy.
+- **Use numbered subheadings**: Use numbered subheadings to indicate the
+  hierarchy of sections and subsections. (like `1.1`, `1.1.1`, `1.1.2`, etc.)
+- **Use bullet points for lists**: Use bullet points for lists of items to
+  improve readability.
+- **Use code blocks for code snippets**: Enclose code snippets in code blocks to
+  distinguish them from regular text.
+- **Use bold for emphasis**: Use bold text to highlight key points, terms, or
+  concepts.
+- **Use italics for emphasis**: Use italics to emphasize specific words or
+  phrases.
+- **Use links for references**: Use hyperlinks to reference external resources,
+  tools, or related content.
+- **Use images for visual aids**: Include images, diagrams, or charts to enhance
+  the visual appeal and understanding of the content.
+
+## Authorship
+
+When contributing to the QA architecture handbook, your contributions will be
+shown in AUTHORS.md file when merged. That's why it's important to provide your
+name and email address in the commit message.

README.md

@@ -1,2 +1,65 @@
-# the-qa-architecture-handbook
-This guide provides a structured framework and practical advice for building a rock-solid, end-to-end QA architecture in an organization.
+# The QA architecture handbook: Guide for building a quality-first culture
+
+This short guide provides a structured framework and practical advice for
+building a rock-solid, end-to-end QA architecture in an organization.
+
+This handbook is designed to assist you, whether you are beginning to develop
+your QA processes, or you're seeking to enhance your current practices, by
+outlining the key steps and important factors to consider.
+
+## Core philosophy
+
+Before exploring the details, it is essential to recognize a key principle:
+**Quality is not exclusively the duty of the QA team; rather, it is a collective
+responsibility that encompasses all teams and individuals engaged in the
+software development process.**
+
+This handbook aims to assist you in cultivating a quality-first culture,
+empowering everyone to play a role in delivering outstanding products.
+
+## Four pillars of a QA architecture
+
+<!-- markdownlint-disable-next-line -->
+<p align="center">
+  <!-- markdownlint-disable-next-line -->
+  <img
+  src="https://github.com/user-attachments/assets/b63e8bdc-fbed-43b8-8eab-b165f84db3ea"
+  alt="four-pillars">
+</p>
+
+We will explore the journey of creating a solid QA architecture through four key
+pillars that are closely linked:
+
+- **Culture foundation**: Fostering a quality culture; establishing a
+  quality-first mindset and creating vital planning processes to support it.
+- **Core infrastructure**: Continuous deployments, continuous monitoring and
+  early issues detection; developing a strong infrastructure for ongoing
+  monitoring, proactive identification of issues, and ensuring security.
+- **Automations**: We should scale our confidence by deploying a thorough range
+  of automated processes and tests to guarantee processes and code quality,
+  functionality, and performance.
+- **Exploratory and manual testing**: Now the human element, utilizing human
+  insight, creativity, and feedback from real users to identify problems and
+  enhance the overall user experience.
+
+## Sections & Resources
+
+- Go to [Section 1: Culture foundation](./docs/culture-foundation.md) -
+  cultivating a quality culture
+- Go to [Section 2: Core infrastructure](./docs/core-infrastructure.md) -
+  monitoring and early detection
+- Go to [Section 3: Automations](./docs/automations.md) - building confidence at
+  scale
+- Go to [Section 4: Exploratory and manual testing](./docs/human-touch.md) - the
+  human touch
+
+## Contribution and style guidelines
+
+Your contributions to this handbook are highly appreciated. To ensure
+consistency and readability, we created a set of guidelines. Please refer to the
+[Contribution and style guidelines](./CONTRIBUTION.md) for more details.
+
+## License
+
+This handbook is licensed under the [MIT License](./LICENSE). Feel free to use,
+share, and modify it according to your needs.