Skip to content

Commit 79157c6

Browse files
committed
Add HUMAN.md
1 parent 37a1186 commit 79157c6

File tree

10 files changed

+53
-27
lines changed

10 files changed

+53
-27
lines changed

AGENTS.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,6 @@
22

33
## Coding
44

5-
### Package management
6-
7-
- When adding dependencies, use `npm install`
8-
- Do not add it to workspace root
9-
- If it is an existing package, must use consistent version: either use existing version for the package or consider bumping every dependents to latest
10-
- Unless stated otherwise, avoid Node.js packages or polyfills
11-
- Use `ReadableStream`, `WritableStream`, `TransformStream`, instead of Node.js `buffer`
12-
- Use Web Cryptography instead of Node.js `crypto`
13-
- Do not use `fs`-like or `net`-like packages
14-
- Do not use any Browserify-like packages
15-
- Unless stated otherwise, verify newly added packages and transient packages must be either platform-neutral, browser-specific, or React-specific
16-
- Do not add external/publishing packages unless explicitly requested
17-
- Always prefix internal/non-publishing packages with `@msinternal/` to prevent package squatting
18-
195
### General
206

217
- Unless stated otherwise, avoid Node.js

HUMAN.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# HUMAN.md for Bot Framework Web Chat
2+
3+
## Coding
4+
5+
### Package management
6+
7+
- When adding dependencies, use `npm install`
8+
- Do not add it to workspace root
9+
- If it is an existing package, must use consistent version: either use existing version for the package or consider bumping every dependents to latest
10+
- Unless stated otherwise, avoid Node.js packages or polyfills
11+
- Use `ReadableStream`, `WritableStream`, `TransformStream`, instead of Node.js `buffer`
12+
- Use Web Cryptography instead of Node.js `crypto`
13+
- Do not use `fs`-like or `net`-like packages
14+
- Do not use any Browserify-like packages
15+
- Unless stated otherwise, verify newly added packages and transient packages must be either platform-neutral, browser-specific, or React-specific
16+
- Do not add external/publishing packages unless explicitly requested
17+
- Always prefix internal/non-publishing packages with `@msinternal/` to prevent package squatting
18+
19+
### Platform level
20+
21+
| Package family | Level | Platform-neutral | React Native | Full Browser | React | Node.js |
22+
| ------------------------ | ------------ | ---------------- | ------------ | ------------ | ----- | ------- |
23+
| `base` | Neutral | Yes | No | No | No | No |
24+
| `core` | Neutral | Yes | No | No | No | No |
25+
| `api` | React Native | Yes | Yes | No | No | No |
26+
| `react-*` | React Native | Yes | Yes | No | No | No |
27+
| `redux-*` | React Native | Yes | Yes | No | No | No |
28+
| `component` | React (HTML) | Yes | Yes | Yes | Yes | No |
29+
| `bundle` | React (HTML) | Yes | Yes | Yes | Yes | No |
30+
| `fluent-theme`/`*-theme` | React (HTML) | Yes | Yes | Yes | Yes | No |
31+
| `support` | Neutral | Yes | No | Yes | No | No |
32+
33+
In the order of platform support:
34+
35+
1. Neutral: JavaScript engine only, logic only, UI-agnostic, minimal
36+
2. React Native: browser-like but not full browser, mobile app or web app
37+
3. React (HTML): full browser, web app

packages/api-graph/AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AGENTS.md
2+
3+
Refer to `/packages/api/AGENTS.md`.

packages/api-middleware/AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AGENTS.md
2+
3+
Refer to `/packages/api/AGENTS.md`.

packages/api/AGENTS.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# AGENTS.md for `botframework-webchat-api`
1+
# AGENTS.md
22

33
## Coding
44

5-
- Allow browser technologies, but no Node.js nor React
6-
- Newly added packages and transient packages must be platform-neutral or browser-specific
5+
- The code could run on React Native, no browser-specific technologies

packages/base/AGENTS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# AGENTS.md for `botframework-webchat-base`
1+
# AGENTS.md
22

33
## Coding
44

55
- Stay platform neutral, no browser technologies, no Node.js, no React
6-
- Newly added packages and transient packages must be platform-neutral

packages/core-debug-api/AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AGENTS.md
2+
3+
Refer to `/packages/core/AGENTS.md`.

packages/core-graph/AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AGENTS.md
2+
3+
Refer to `/packages/core/AGENTS.md`.

packages/core/AGENTS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# AGENTS.md for `botframework-webchat-core`
1+
# AGENTS.md
22

33
## Coding
44

55
- Stay platform neutral, no browser technologies, no Node.js, no React
6-
- Newly added packages and transient packages must be platform-neutral

packages/test/AGENTS.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)