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: docs/README.md
+52-1Lines changed: 52 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Welcome to the codebase interface initiative!
4
4
5
5
The codebase interface is a set of principles and practices that allow us to identify and understand all perspectives of interacting with a codebase, including contributors, users, operators, AI agents, and build agents.
6
6
7
-
By providing specific interfaces for each audience perspective, we can ensure that everyone has a clean and maintainable experience when interacting with a codebase.
7
+
By providing specific interfaces for each audience perspective, we can ensure that we help all users of the codebase by providing a great experience with clean and maintainable interfaces for all!
8
8
9
9
## Guide
10
10
@@ -15,6 +15,57 @@ By providing specific interfaces for each audience perspective, we can ensure th
15
15
-[Examples](./examples.md)
16
16
-[Tooling](./tooling.md)
17
17
18
+
## Overview
19
+
20
+
Remember your codebase is a product with multiple users. We should treat it as such by providing great experiences for all audiences that interact with it.
21
+
22
+
## Overview
23
+
24
+
Remember your codebase is a product with multiple users. We should treat it as such by providing great experiences for all audiences that interact with it.
class README,CONTRIBUTING,RUNBOOK,AGENTS,BUILD interface
66
+
class USERS,CONTRIBUTORS,OPERATORS,AI_AGENTS,BUILD_AGENTS audience
67
+
```
68
+
18
69
## Support
19
70
20
71
If your codebase uses codebase interface principles please support the initiative by starring the [Codebase Interface GitHub repository](https://github.com/codebase-interface/codebaseinterface){target="_blank"} and placing the below markdown in the README of your repo.
0 commit comments