You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+35-15Lines changed: 35 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,14 +66,14 @@ flowchart LR
66
66
F --> H[[Step 7<br />GitHub Review]]
67
67
H --> I[Step 8<br />Publish]
68
68
69
-
style A fill:pink
70
-
style B fill:pink
71
-
style C fill:pink
72
-
style D fill:pink
73
-
style E fill:yellow
74
-
style F fill:pink
75
-
style H fill:silver
76
-
style I fill:yellow
69
+
style A fill:pink,color:#000
70
+
style B fill:pink,color:#000
71
+
style C fill:pink,color:#000
72
+
style D fill:pink,color:#000
73
+
style E fill:yellow,color:#000
74
+
style F fill:pink,color:#000
75
+
style H fill:silver,color:#000
76
+
style I fill:yellow,color:#000
77
77
```
78
78
79
79
**Legend:**
@@ -342,19 +342,18 @@ There are several primary types of contributions to this project:
342
342
343
343
### 📝 Content Library Article Submission(s)
344
344
345
-
Contributions will typically author content articles. To start writing, we recommend review these essential framework resources:
345
+
Contributions will typically author content articles under `/content/` folder. To start writing, we recommend reviewing these essential framework resources:
346
346
347
347
-[Framework Overview] - Learn about the WAF mission, vision, objectives, and five pillars
348
-
-[Project Structure](/docs/project-structure.md) - Understand the repository layout and where content lives
349
348
-[Taxonomies](/docs/taxonomies.md) - Explore the design principles, areas, and other classifications
350
349
351
350
**Inspiration for Content Library articles** comes from **Azure Architecture Center**. See the following example articles for your inspiration: 💡
352
351
353
-
-[📄 Reliability: Recommendations for designing for redundancy](https://learn.microsoft.com/en-us/azure/well-architected/reliability/redundancy)
354
-
-[📄 Security: Recommendations for identity and access management](https://learn.microsoft.com/en-us/azure/well-architected/security/identity-access)
355
-
-[📄 Cost Optimization: Recommendations for optimizing environment costs](https://learn.microsoft.com/en-us/azure/well-architected/cost-optimization/optimize-environment-costs)
356
-
-[📄 Operational Excellence: Recommendations for using infrastructure as code](https://learn.microsoft.com/en-us/azure/well-architected/operational-excellence/infrastructure-as-code-design)
357
-
-[📄 Performance Efficiency: Recommendations for capacity planning](https://learn.microsoft.com/en-us/azure/well-architected/performance-efficiency/capacity-planning)
352
+
-[📄 Reliability: Recommendations for designing for redundancy][reliability-redundancy]
353
+
-[📄 Security: Recommendations for identity and access management][security-identity-access]
354
+
-[📄 Cost Optimization: Recommendations for optimizing environment costs][cost-optimize-environment]
355
+
-[📄 Operational Excellence: Recommendations for using infrastructure as code][operational-iac]
356
+
-[📄 Performance Efficiency: Recommendations for capacity planning][performance-capacity-planning]
358
357
359
358
### 💻 Website Code Changes
360
359
@@ -412,6 +411,22 @@ See [Framework Overview] for details on each pillar.
412
411
- Keep sentences **short and clear**
413
412
- Avoid unnecessary jargon
414
413
- Include practical examples
414
+
- Prefer GitHub Docs links to **Enterprise Cloud**: `https://docs.github.com/en/enterprise-cloud@latest` (unless the guidance is specific to GitHub Enterprise Server)
415
+
- Use Hugo shortcodes to keep articles consistent (see `archetypes/default.md`):
416
+
- Further assistance: `{{% seeking-further-assistance-details %}}`
417
+
- Related links: `{{% related-links-github-docs %}}`
418
+
419
+
### Callouts
420
+
421
+
Use Hextra callouts to highlight important information:
422
+
423
+
```md
424
+
{{< callout type="info" >}}
425
+
This is an informational note.
426
+
{{< /callout >}}
427
+
```
428
+
429
+
Use `type` for standard callouts (`info`, `warning`, `error`). For custom callouts, use `emoji`.
415
430
416
431
> [!IMPORTANT]
417
432
> Remember: [GitHub Docs] is the primary source of truth. Our framework supplements documentation with design thinking and decision-making guidance.
@@ -483,3 +498,8 @@ By contributing, you agree that your contributions will be licensed under the [M
483
498
[Framework Overview]: /docs/framework-overview.md
484
499
[Create a content request Issue]: https://github.com/github/github-well-architected-internal/issues/new?template=request-content.yml
0 commit comments