Skip to content

Commit 071264f

Browse files
dahliaclaude
andcommitted
Add checklist for new environment variables to AGENTS.md
Document the steps required when adding new configuration options: - Update source code with env var reading logic - Add to AGENTS.md environment variables tables - Update documentation site in all 4 languages - Update Docker Compose files if relevant - Document in CHANGES.md changelog Co-Authored-By: Claude <[email protected]>
1 parent a65a668 commit 071264f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,34 @@ STORAGE_URL_BASE=https://your-bucket.s3.amazonaws.com
371371
| `REMOTE_ACTOR_FETCH_POSTS`| 10 | Posts to fetch from remote actors|
372372

373373

374+
Adding new environment variables
375+
--------------------------------
376+
377+
When adding a new environment variable to Hollo, update these locations:
378+
379+
1. *Source code*: Add the environment variable reading logic in
380+
the appropriate source file (e.g., *src/logging.ts*, *src/storage.ts*).
381+
382+
2. *AGENTS.md* (this file): Add the variable to the environment variables
383+
tables above (required or optional section as appropriate).
384+
385+
3. *Documentation site*: Update the installation guides in
386+
*docs/src/content/docs/install/* for all languages:
387+
388+
- *docs/src/content/docs/install/* (English)
389+
- *docs/src/content/docs/ja/install/* (Japanese)
390+
- *docs/src/content/docs/ko/install/* (Korean)
391+
- *docs/src/content/docs/zh-cn/install/* (Simplified Chinese)
392+
393+
4. *Docker Compose files*: If the variable is relevant for Docker deployments:
394+
395+
- *compose.yaml*: For S3 storage configuration
396+
- *compose-fs.yaml*: For filesystem storage configuration
397+
398+
5. *Changelog*: Document the new variable in *CHANGES.md* under the current
399+
version section.
400+
401+
374402
Important notes
375403
---------------
376404

0 commit comments

Comments
 (0)