Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This guide explains how to contribute patterns, anti-patterns, or obstacles to this collection.

By contributing, you agree that your written content is licensed under [CC BY 4.0](./LICENSE) and your code under [MIT](./LICENSE-CODE), like the rest of the repository.

## Content Types & Locations

- **Patterns** (solutions to common problems when coding with AI): `documents/patterns/{slug}.md`
Expand Down
396 changes: 396 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions LICENSE-CODE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2025 Lada Kesseler, Ivett Ördög, and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,19 @@ See [CONTRIBUTE.md](./CONTRIBUTE.md) for detailed guidelines on adding patterns,
**Using Claude Code?** Run `/contribute` to start an interactive contribution workflow.

New contributions go in the appropriate `documents/` subdirectory following the structure and format described in the contributing guide.

## License

The patterns, anti-patterns, obstacles, and other written content are licensed under [CC BY 4.0](./LICENSE). You can share and adapt them for any purpose, including commercial use like paid courses and books, as long as you give credit.

The code in `website/`, `scripts/`, `tools/`, and the shell scripts at the root is licensed under [MIT](./LICENSE-CODE).

## How to Cite

For the whole collection:

> Augmented Coding Patterns by Lada Kesseler, Ivett Ördög, and contributors, licensed under CC BY 4.0. https://ai-coding-patterns.dev/

For a single pattern, name its authors (shown on its page) and link to it:

> "Pattern Name" by Author Name, from Augmented Coding Patterns, licensed under CC BY 4.0. https://ai-coding-patterns.dev/patterns/pattern-name/
2 changes: 1 addition & 1 deletion website/app/contributors/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export default function ContributorsPage() {
<p className={styles.description}>
Want to contribute? Read the{" "}
<Link
href={`${siteConfig.links.github}/blob/main/CONTRIBUTE.md`}
href={siteConfig.links.contribute}
target="_blank"
rel="noopener noreferrer"
>
Expand Down
19 changes: 15 additions & 4 deletions website/app/layout.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,17 @@

.footerLinks {
display: flex;
gap: var(--space-lg);
flex-wrap: wrap;
justify-content: center;
margin-top: var(--space-md);
margin: var(--space-md) 0 0;
padding: 0;
list-style: none;
color: var(--color-text-tertiary);
}

.footerLinks li + li::before {
content: "·";
margin: 0 var(--space-sm);
}

.footerLink {
Expand Down Expand Up @@ -152,7 +160,10 @@
}

.footerLinks {
flex-direction: column;
gap: var(--space-sm);
gap: var(--space-sm) var(--space-lg);
}

.footerLinks li + li::before {
content: none;
}
}
53 changes: 40 additions & 13 deletions website/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -72,23 +72,50 @@ export default function RootLayout({

<footer className={styles.footer}>
<div className={styles.footerContent}>
<p>
{siteConfig.name} - A guide to effective AI-augmented software development
</p>
<div className={styles.footerLinks}>
<a
href={siteConfig.links.github}
className={styles.footerLink}
target="_blank"
rel="noopener noreferrer"
>
GitHub
</a>
</div>
<p>{siteConfig.tagline}</p>
<ul className={styles.footerLinks}>
<li>
<FooterLink href={siteConfig.links.github}>GitHub</FooterLink>
</li>
<li>
<FooterLink href={siteConfig.links.contribute}>Contribute</FooterLink>
</li>
<li>
License: content{" "}
<FooterLink href={siteConfig.licenses.content.url} isLicense>
{siteConfig.licenses.content.name}
</FooterLink>
, code{" "}
<FooterLink href={siteConfig.licenses.code.url} isLicense>
{siteConfig.licenses.code.name}
</FooterLink>
</li>
</ul>
</div>
</footer>
</div>
</body>
</html>
);
}

function FooterLink({
href,
isLicense = false,
children,
}: Readonly<{
href: string;
isLicense?: boolean;
children: React.ReactNode;
}>) {
return (
<a
href={href}
className={styles.footerLink}
target="_blank"
rel={isLicense ? "license noopener noreferrer" : "noopener noreferrer"}
>
{children}
</a>
);
}
18 changes: 16 additions & 2 deletions website/config/site.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
const repositoryUrl = 'https://github.com/lexler/augmented-coding-patterns'

export const siteConfig = {
name: 'Augmented Coding Patterns',
description: 'A collection of emerging patterns, anti-patterns, and obstacles for effective AI-augmented software development',
Expand All @@ -8,10 +10,22 @@ export const siteConfig = {
repository: {
owner: 'lexler',
name: 'augmented-coding-patterns',
url: 'https://github.com/lexler/augmented-coding-patterns'
url: repositoryUrl
},
tagline: 'Patterns for building software with AI',
links: {
github: 'https://github.com/lexler/augmented-coding-patterns'
github: repositoryUrl,
contribute: `${repositoryUrl}/blob/main/CONTRIBUTE.md`
},
licenses: {
content: {
name: 'CC BY 4.0',
url: 'https://creativecommons.org/licenses/by/4.0/'
},
code: {
name: 'MIT',
url: `${repositoryUrl}/blob/main/LICENSE-CODE`
}
}
} as const

Expand Down
28 changes: 26 additions & 2 deletions website/tests/unit/components/layout.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ describe('RootLayout', () => {
})

describe('Footer', () => {
it('renders footer with site description', () => {
const footerText = screen.getByText(/A guide to effective AI-augmented software development/i)
it('renders footer with site tagline', () => {
const footerText = screen.getByText('Patterns for building software with AI')
expect(footerText).toBeInTheDocument()
})

Expand All @@ -101,6 +101,30 @@ describe('RootLayout', () => {
expect(githubLink).toHaveAttribute('rel', 'noopener noreferrer')
})

it('links the contribution guide', () => {
const contributeLink = screen.getByRole('link', { name: 'Contribute' })
expect(contributeLink).toHaveAttribute('href', `${siteConfig.repository.url}/blob/main/CONTRIBUTE.md`)
expect(contributeLink).toHaveAttribute('target', '_blank')
expect(contributeLink).toHaveAttribute('rel', 'noopener noreferrer')
})

it('labels the licenses for content and code', () => {
const footer = screen.getByRole('contentinfo')
expect(footer).toHaveTextContent('License: content CC BY 4.0, code MIT')
})

it('links the content license', () => {
const contentLicense = screen.getByRole('link', { name: 'CC BY 4.0' })
expect(contentLicense).toHaveAttribute('href', 'https://creativecommons.org/licenses/by/4.0/')
expect(contentLicense).toHaveAttribute('rel', 'license noopener noreferrer')
})

it('links the code license', () => {
const codeLicense = screen.getByRole('link', { name: 'MIT' })
expect(codeLicense).toHaveAttribute('href', `${siteConfig.repository.url}/blob/main/LICENSE-CODE`)
expect(codeLicense).toHaveAttribute('rel', 'license noopener noreferrer')
})

it('has proper semantic HTML structure with footer element', () => {
const footer = document.querySelector('footer')
expect(footer).toBeInTheDocument()
Expand Down
Loading