From 6891b9d594ba02bea4d4dd1a8e3d2003d8a786db Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Tue, 24 Jun 2025 23:26:45 -0500 Subject: [PATCH 1/2] Add AGENTS guidelines --- AGENTS.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..77eb722 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,40 @@ +# AGENTS Guidelines for Sortana + +This file provides guidelines for codex agents contributing to the Sortana project. It describes the repository structure, the expected coding conventions, and testing commands. If a section is not applicable yet, you may leave it blank or provide placeholders. + +## Repository Overview + +- `background.js`: Handles startup tasks and message passing between the extension and experiment APIs. +- `experiment/`: Contains the privileged API scripts used by Thunderbird. +- `modules/`: Holds reusable JavaScript modules for the extension. +- `content/`: Scripts for modifying Thunderbird windows (e.g., the filter editor). +- `options/`: The options page HTML and JavaScript. +- `resources/`: Images and other static files. +- `prompt_templates/`: Prompt template files for the AI service. +- `build-xpi.ps1`: PowerShell script to package the extension. + +## Coding Style + +- Use **modern JavaScript** (ES6 or later). Prefer `const` and `let` over `var`. +- Keep functions small and focused. Aim for clear naming and concise comments when necessary. +- Use template literals for string interpolation. +- Avoid trailing whitespace and ensure files end with a newline. + +## Commit Guidelines + +- Group related changes together. Each commit should have a clear purpose. +- Use descriptive commit messages in the imperative mood (e.g., "Add filter editor patch"). +- Run `git status` before committing to verify only intended files are staged. + +## Testing + +There are currently no automated tests for this project. If you add tests in the future, specify the commands to run them here. For now, verify the extension manually in Thunderbird. + +## Documentation + +Additional documentation might exist outside this repository. Replace the placeholders below with the correct URLs if available. + +- Development guide: +- Issue tracker: +- Extension homepage: + From c3ebf5f53016c6e40246885d18790ba93aa86d84 Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Tue, 24 Jun 2025 23:34:59 -0500 Subject: [PATCH 2/2] Update AGENTS.md Fill in specifics. --- AGENTS.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 77eb722..94919e9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # AGENTS Guidelines for Sortana -This file provides guidelines for codex agents contributing to the Sortana project. It describes the repository structure, the expected coding conventions, and testing commands. If a section is not applicable yet, you may leave it blank or provide placeholders. +This file provides guidelines for codex agents contributing to the Sortana project. It describes the repository structure, the expected coding conventions, and testing commands. If you make changes to Sortana, make sure to update this document and the README.md if applicable. ## Repository Overview @@ -28,13 +28,14 @@ This file provides guidelines for codex agents contributing to the Sortana proje ## Testing -There are currently no automated tests for this project. If you add tests in the future, specify the commands to run them here. For now, verify the extension manually in Thunderbird. +There are currently no automated tests for this project. If you add tests in the future, specify the commands to run them here. For now, verification must happen manually in Thunderbird. ## Documentation -Additional documentation might exist outside this repository. Replace the placeholders below with the correct URLs if available. +Additional documentation exists outside this repository. -- Development guide: -- Issue tracker: -- Extension homepage: +- Development guide: [Webextention-API for Thunderbird](https://webextension-api.thunderbird.net/en/stable/) + - [Messages API](https://webextension-api.thunderbird.net/en/stable/messages.html) + - [Storage API](https://webextension-api.thunderbird.net/en/stable/storage.html) +- Issue tracker: [Thunderbird tracker on Bugzilla](https://bugzilla.mozilla.org/describecomponents.cgi?product=Thunderbird)