{"id":42802420,"url":"https://github.com/github/github-well-architected","last_synced_at":"2026-01-30T03:14:47.326Z","repository":{"id":334942289,"uuid":"1112816246","full_name":"github/github-well-architected","owner":"github","description":"Apply design thinking to build and ship your software securely and at scale with GitHub","archived":false,"fork":false,"pushed_at":"2026-01-27T16:50:38.000Z","size":14998,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-28T03:11:18.903Z","etag":null,"topics":["adoption","application-security","architecture","certifications","collaboration","github","governance","offerings","partners","productivity","services","waf","well-architected"],"latest_commit_sha":null,"homepage":"https://wellarchitected.github.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-09T06:19:10.000Z","updated_at":"2026-01-27T16:56:02.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/github/github-well-architected","commit_stats":null,"previous_names":["github/github-well-architected"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/github/github-well-architected","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgithub-well-architected","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgithub-well-architected/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgithub-well-architected/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgithub-well-architected/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/github-well-architected/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgithub-well-architected/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28897980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T21:06:44.224Z","status":"online","status_checked_at":"2026-01-30T02:00:06.810Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adoption","application-security","architecture","certifications","collaboration","github","governance","offerings","partners","productivity","services","waf","well-architected"],"created_at":"2026-01-30T03:14:42.368Z","updated_at":"2026-01-30T03:14:47.318Z","avatar_url":"https://github.com/github.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable MD032 --\u003e\n\u003c!-- markdownlint-disable MD034 --\u003e\n\u003c!-- markdownlint-disable MD036 --\u003e\n\u003c!-- markdownlint-disable MD041 --\u003e\n\n[![CI for PR](https://github.com/github/github-well-architected/actions/workflows/pr-check.yml/badge.svg)](https://github.com/github/github-well-architected/actions/workflows/pr-check.yml)\n[![CI for GitHub Review](https://github.com/github/github-well-architected/actions/workflows/deploy-merged-pr.yml/badge.svg)](https://github.com/github/github-well-architected/actions/workflows/deploy-merged-pr.yml)\n[![CodeQL](https://github.com/github/github-well-architected/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/github/github-well-architected/actions/workflows/github-code-scanning/codeql)\n\n![GH-WAF-Banner](https://user-images.githubusercontent.com/13181456/213116450-422a10b9-7f4e-485b-a027-48b0c33f94ee.png)\n\n## Welcome\n\nThis repository maintains the static site for the [GitHub Well-Architected Framework](https://wellarchitected.github.com) and its Content Library. The site provides opinionated, community-driven guidance for adopting and deploying the GitHub platform effectively.\n\n**Quick links:**\n\n- 🌐 [View the site](https://wellarchitected.github.com)\n- 💬 [Discussions](https://github.com/github/github-well-architected/discussions)\n- 📖 [Contributing Guide](CONTRIBUTING.md)\n\n[🎬 Watch the Teaser video](https://github.com/user-attachments/assets/51fc5744-a61b-4119-8892-bd93b1c26fe8)\n\n---\n\n## Quick start\n\nGet started contributing to the GitHub Well-Architected Framework in three steps:\n\n### 1. Start with GitHub Codespaces\n\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/github/github-well-architected)\n\n### 2. Create a new article\n\nChoose a pillar: `productivity`, `collaboration`, `application-security`, `governance`, or `architecture`\n\n```bash\nhugo new content library/{PILLAR}/recommendations/{ARTICLE-NAME}.md\n```\n\n### 3. View the site\n\n```bash\ntools/server\n```\n\nOpen the site when prompted in Codespaces.\n\n---\n\n## Documentation\n\nFor public information about the framework, see the [docs/README](docs/README.md) and directory:\n\n- **[Framework Overview](docs/framework-overview.md)**: Mission, vision, objectives, pillars, and design principles\n- **[Taxonomies](docs/taxonomies.md)**: Complete reference for categorizing Content Library articles\n\n---\n\n## Development\n\nWe recommend using GitHub Codespaces for the seamless contribution experience. If you prefer to set up your environment locally, follow the instructions below.\n\n### Prerequisites\n\nBefore you can run this project locally, you need:\n\n- [Node.js](https://nodejs.org/en/download/)\n- [npm](https://www.npmjs.com/get-npm) (comes with Node.js)\n- [Hugo](https://gohugo.io/getting-started/installing/)\n\n### Setup\n\nClone this repository (if using HTTPS):\n\n```bash\ngit clone https://github.com/github/github-well-architected.git\n```\n\nInitialize your workspace:\n\n```bash\ntools/setup\n```\n\n### Running locally\n\nTo run the site locally, use the following command:\n\n```bash\nexport SITE_URL=http://localhost:1313/\ntools/server\n```\n\nThis script starts the Hugo development server and automatically opens the site in your default browser at `http://localhost:1313/`.\n\n- The server watches for changes and reloads the site automatically.\n- If you need to specify a different port, set the `PORT` environment variable before running the script:\n\n  ```bash\n  PORT=8080 tools/server\n  ```\n\n- For troubleshooting, check the terminal output for errors or logs.\n\n### Testing\n\nSet the site URL for tests:\n\n```bash\nexport SITE_URL=http://localhost:1313/\n```\n\nRun all tests:\n\n```bash\ntools/test\n```\n\nRun only functional tests:\n\n```bash\ntools/test --functional\n```\n\nRun linter:\n\n```bash\ntools/lint\n```\n\nReview test output for errors and address any failures before submitting changes.\n\nFor more detailed development instructions, including GitHub Codespaces setup, see the [Contributing Guide](CONTRIBUTING.md).\n\n---\n\n## License\n\nThis project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.\n\n## Special thanks\n\nThanks to these [wonderful contributors](docs/contributors.md), as well as authors in Issues and Discussions for their contributions to the success of the GitHub Well-Architected Framework.\n\n![Contributors](docs/contributors-montage.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fgithub-well-architected","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Fgithub-well-architected","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fgithub-well-architected/lists"}