Contributing¶

Thank you for your interest in contributing to the companion repository for Blueprint for an AI-First Company. This repository contains frameworks, checklists, code examples, and resources that supplement the book. Community contributions help keep these materials accurate, relevant, and useful.

Suggesting Resources¶

If you have found a tool, research paper, case study, course, or community that would fit the resources section, please open an issue using the Resource Suggestion template. Include:

The resource name and URL
Which resource file it belongs in (e.g., resources/tools.md)
A brief description of why it is relevant

If you have built something using patterns from the book and want to share it, open an issue using the Example Submission template. Include:

A description of what the example demonstrates
Which chapter or framework it relates to
The language and dependencies used
A link to your code or a summary of the implementation

We will work with you to determine the best way to include it.

Reporting Issues¶

If you find broken links, factual errors, outdated information, or formatting problems, please open an issue using the Bug Report template. Include:

The file path where the issue exists
A description of the problem
The expected correction, if known

Pull Request Process¶

Fork the repository and create a feature branch from main.
Make your changes in the feature branch.
Ensure all relative links in your changes resolve correctly.
Write a clear pull request description explaining what you changed and why.
Submit the pull request against main.

A maintainer will review your pull request and may request changes before merging. Please be patient and responsive to feedback.

Style Guidelines¶

Use standard Markdown formatting. Do not use wiki-style links.
All internal links must be relative paths (e.g., frameworks/12-data-flywheel.md, not absolute URLs).
Keep descriptions concise and actionable.
Code examples should be minimal, well-commented, and educational. They are meant to illustrate patterns, not serve as production-ready implementations.
Do not include emojis in file content.
Use ATX-style headers (#, ##, ###).
Use tables for structured comparisons and bulleted lists for shorter enumerations.

Code of Conduct¶

All contributors are expected to follow our Code of Conduct. Please read it before participating.

License¶

By contributing to this repository, you agree that your contributions will be licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license, the same license that covers the rest of this repository.