Skip to content

Commit 39b3da7

Browse files
paaloeyeclaude
andcommitted
docs: update repository configuration and templates
- enhanced PR template with improved sections and comprehensive metadata - added CLAUDE.md for AI assisted development guidance - updated .gitignore to track CLAUDE.md - fixed company name consistency (Åndra → Aandra) in LICENSE and README 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-Off-By: Paal Øye-Strømme <paal.o.eye@gmail.com>
1 parent f4d7556 commit 39b3da7

5 files changed

Lines changed: 106 additions & 25 deletions

File tree

.github/pull_request_template.md

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# :checkered_flag: Summary
2-
<!-- Provide a concise summary of your changes (max 140 chars) -->
1+
# :rocket: Summary
2+
<!-- Provide a concise summary of your changes -->
33

4-
## :thinking: Motivation and Context
4+
## :dart: Motivation and Context
55
<!-- Why is this change needed? What problem does it solve? -->
66

7-
## :hammer_and_wrench: Changes
7+
## :wrench: Changes
88

99
### :rocket: Features
1010
<!-- List any new features or significant enhancements -->
@@ -15,38 +15,51 @@
1515
### :zap: Improvements
1616
<!-- List any performance or usability improvements -->
1717

18-
### :test_tube: Code Additions
18+
### :construction: Code Additions
1919
<!-- List any file structure or organisation changes -->
2020
<!-- List any new code or libraries added -->
2121

22-
### :ship: DevContainer Updates
23-
<!-- List any changes to development containers -->
24-
25-
## :books: Documentation
22+
### :books: Documentation
2623
<!-- List documentation updates -->
2724

28-
## :toolbox: Development Tools
29-
<!-- List any changes to development tools -->
25+
### :lock: Security & Quality
26+
<!-- List any security improvements or quality enhancements -->
27+
28+
## :bar_chart: Technical Specifications
29+
<!-- List technical details, requirements, or constraints -->
3030

31-
## :camera_flash: Screenshots
31+
## :test_tube: Testing & Validation
32+
<!-- Describe testing approach and validation methods -->
33+
34+
## :camera: Screenshots
3235
<!-- If applicable, add screenshots to help explain your changes -->
3336

3437
## :link: Related Issues
3538
<!-- Link to related issues with the syntax: Fixes #123, Relates to #456 -->
3639

3740
## :white_check_mark: Checklist
3841
- [ ] I have performed a self-review of my code
39-
- [ ] I have added tests that prove my fix/feature works
40-
- [ ] I have updated the documentation accordingly
42+
- [ ] I have added comprehensive documentation
43+
- [ ] I have updated the project structure accordingly
4144
- [ ] My changes generate no new warnings
4245
- [ ] I have checked for compatibility with existing features
46+
- [ ] All pre-commit hooks pass successfully
47+
- [ ] Conventional commit format followed
4348

4449
## :robot: AI Metadata
45-
- Prompt: <!-- The prompt used if AI assisted -->
46-
- Model: <!-- The model used if AI assisted -->
47-
- Mode: <!-- The mode used if AI assisted -->
48-
- Compute: <!-- The compute provider if AI assisted -->
49-
- Context: <!-- The context provided if AI assisted -->
50-
- Editor: <!-- The editor used -->
51-
- Editor-Version: <!-- The editor version -->
52-
- Platform: <!-- The platform you're working on -->
50+
- **Prompt**: <!-- The prompt used if AI assisted -->
51+
- **Model**: <!-- The model used if AI assisted -->
52+
- **Mode**: <!-- The mode used if AI assisted -->
53+
- **Compute**: <!-- The compute provider if AI assisted -->
54+
- **Context**: <!-- The context provided if AI assisted -->
55+
- **Editor**: <!-- The editor used -->
56+
- **Platform**: <!-- The platform you're working on -->
57+
- **Arch**: <!-- The architecture (e.g., arm64, x86_64) -->
58+
- **Total cost**: <!-- Total cost if AI assisted -->
59+
- **API duration**: <!-- API duration if AI assisted -->
60+
- **Wall time**: <!-- Wall time if AI assisted -->
61+
- **Code changes**: <!-- Lines added/removed if applicable -->
62+
- **Usage breakdown**: <!-- Model usage breakdown if AI assisted -->
63+
64+
## :chart_with_upwards_trend: Impact
65+
<!-- Describe the impact and benefits of your changes -->

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@ zig-out/
44
*.o
55

66
# AI-powered DevEx
7-
CLAUDE.md
87
.cursor
98
.claude

CLAUDE.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## IMPORTANT
6+
7+
- ALWAYS read [IDEA.md](./IDEA.md) to stay on point what we build
8+
- USE Emojis in [README.md](./README.md) or **docs/*.md** with care. NOT MUCH.
9+
- ALWAYS read [GOTCHA.md](./GOTCHA.md) before make changes
10+
- PREFER British English over American English spelling and grammar
11+
- Files and Directories MUST NOT have **dashes** in names/paths (Use **underscore** instead)
12+
- NEVER USE Git LFS
13+
- ALL files MUST have final new line (i.e. consistent with **insert_final_newline = true** Editor Config config)
14+
15+
## Project Overview
16+
17+
<!-- AI-TODO -->
18+
19+
## Commit Messages
20+
21+
Follow conventional commit format with detailed explanations and proper sign-off. Use British Spelling.
22+
23+
### Format
24+
25+
```
26+
<type>(<scope>): <subject>
27+
28+
<detailed body explaining what and why in bullet points>
29+
30+
BREAKING CHANGE: <description if applicable>
31+
32+
🤖 Generated with [Claude Code](https://claude.ai/code)
33+
34+
Co-Authored-By: Claude <noreply@anthropic.com>
35+
Signed-Off-By: Paal Øye-Strømme <paal.o.eye@gmail.com>
36+
```
37+
38+
### Best Practices
39+
40+
- **Type**: Use `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
41+
- **Scope**: Specify affected module/component (e.g., `supabase`, `components`, `hooks`)
42+
- **Subject**: Imperative mood, no period, max 50 characters
43+
- **Body**: Explain the what and why, not how. Include context and reasoning in bullet points using "-" as for item mark
44+
- **Breaking Changes**: Always document with `BREAKING CHANGE:` footer
45+
- **Sign-off**: Include Claude Code attribution for AI-generated commits in `Co-Authored-By` and the main committer in `Signed-Off-By`
46+
47+
### Examples
48+
49+
```bash
50+
feat(supabase): add verify-email function
51+
52+
- added verify-email Edge function to confirm users's email
53+
- added tests
54+
55+
fix(components): add toaster
56+
57+
- toaster is used for notification
58+
- no testes yet
59+
60+
docs:: update module usage examples and references
61+
62+
- for consistency
63+
- improved readability
64+
65+
refactor(hooks): change useToast
66+
67+
- fixes #1
68+
- added extra options
69+
```

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Åndra Labs
3+
Copyright (c) 2025 Aandra Labs, Inc.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,4 @@ Join the developers building the next generation of AI applications with sustain
9393

9494
---
9595

96-
*© 2025 Åndra Labs. Building the monetisation layer for the AI economy.*
96+
*© 2025 Aandra Labs, Inc. Building the monetisation layer for the AI economy.*

0 commit comments

Comments
 (0)