-
Notifications
You must be signed in to change notification settings - Fork 186
docs: add detailed agent instructions for testing and spellchecking #1048
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -19,6 +19,10 @@ Before making changes, familiarize yourself with: | |||||||||
| The CONTRIBUTING.md file contains all necessary information for setting up, | ||||||||||
| building, linting, and making changes to the documentation. | ||||||||||
|
|
||||||||||
| **For human-centric guidelines** such as DCO (Developer Certificate of Origin) | ||||||||||
| signing, PR etiquette, and community interaction, refer to [CONTRIBUTING.md](CONTRIBUTING.md) | ||||||||||
| and the [general contributing guidelines](https://github.com/jaegertracing/jaeger/blob/main/CONTRIBUTING_GUIDELINES.md). | ||||||||||
|
|
||||||||||
| ## Agentic Workflow Tips | ||||||||||
|
|
||||||||||
| ### Repository Structure | ||||||||||
|
|
@@ -41,6 +45,79 @@ efficiently: | |||||||||
| - **Deployment**: Netlify automatically deploys from the `main` branch | ||||||||||
| - **Preview**: Netlify creates preview deployments for PRs | ||||||||||
|
|
||||||||||
| ### Testing and Verifying Changes | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this looks like a repetition of what was already stated in CONTRIBUTING. There is no point duplicating guidelines (and having them diverge over time).
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Copilot wasn't doing what was requested, so I wanted to be more explicit in the instructions here. |
||||||||||
|
|
||||||||||
| Before submitting a PR, verify your changes locally: | ||||||||||
|
|
||||||||||
| #### 1. Setup (First Time Only) | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm install | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| This installs all dependencies including the required Hugo version. | ||||||||||
|
|
||||||||||
| #### 2. Run the Site Locally | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| make develop | ||||||||||
| # or | ||||||||||
| npm run serve | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| This starts a local server at [localhost:1313](http://localhost:1313) with hot | ||||||||||
| reload. Verify your changes render correctly in the browser. | ||||||||||
|
|
||||||||||
| #### 3. Build the Site | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm run build | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Ensure the build completes without errors before submitting a PR. | ||||||||||
|
|
||||||||||
| #### 4. Run All Checks | ||||||||||
|
|
||||||||||
| Run these commands to verify CI will pass: | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm run check:format # Check code formatting | ||||||||||
| npm run check:spelling # Run spellcheck | ||||||||||
| npm run check:links:internal # Check internal links (faster) | ||||||||||
| npm run check:filenames # Check filename conventions | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| For comprehensive link checking (including external links): | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm run check:links:all # Check all links (slower, builds site first) | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| #### 5. Fix Common Issues | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm run fix:format # Auto-fix formatting issues | ||||||||||
| npm run fix:filenames # Convert underscores to hyphens in filenames | ||||||||||
| npm run fix # Run both fixes | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ### Spellchecking | ||||||||||
|
|
||||||||||
| The repository uses [cspell](https://cspell.org/) for spellchecking. Configuration | ||||||||||
| is in `.cspell.yml` with custom dictionaries in the `.cspell/` directory. | ||||||||||
|
|
||||||||||
| If the spellchecker flags a legitimate word (technical term, proper noun, etc.): | ||||||||||
|
|
||||||||||
| 1. **For general technical terms**: Add to `.cspell/project-words.txt` | ||||||||||
| 2. **For people's names**: Add to `.cspell/project-names-src.txt` | ||||||||||
|
|
||||||||||
| **Important rules for `project-words.txt`:** | ||||||||||
|
|
||||||||||
| - Words must be sorted alphabetically (case-insensitive) | ||||||||||
| - One word per line | ||||||||||
| - The file is case-sensitive, so add the exact casing needed | ||||||||||
| - Run `sort -c --ignore-case .cspell/project-words.txt` to verify sorting | ||||||||||
|
|
||||||||||
| ### Troubleshooting | ||||||||||
|
|
||||||||||
| #### Link Checker Issues | ||||||||||
|
|
@@ -61,11 +138,24 @@ Common issues: | |||||||||
|
|
||||||||||
| #### Filename Violations | ||||||||||
|
|
||||||||||
| If CI complains about filename conventions: | ||||||||||
| Run `npm run fix:filenames` to auto-fix. | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| npm run fix:filenames | ||||||||||
| ``` | ||||||||||
| #### Spellcheck Failures | ||||||||||
|
|
||||||||||
| 1. Review the flagged words in the output | ||||||||||
| 2. If the word is misspelled, fix it in the content | ||||||||||
| 3. If the word is legitimate, add it to the appropriate dictionary file | ||||||||||
| 4. Ensure `project-words.txt` remains sorted alphabetically | ||||||||||
|
|
||||||||||
| ### Documentation Versioning | ||||||||||
|
|
||||||||||
| When making documentation changes: | ||||||||||
|
|
||||||||||
| - **New features/changes**: Edit files in `content/docs/v2/_dev/` (for next release) | ||||||||||
| - **Fixes for current version**: Apply to both `_dev/` and the most recent version | ||||||||||
| directory (e.g., `content/docs/v2/2.x/`) so changes appear immediately on the | ||||||||||
| live site | ||||||||||
|
Comment on lines
+156
to
+157
|
||||||||||
| directory (e.g., `content/docs/v2/2.x/`) so changes appear immediately on the | |
| live site | |
| directory (e.g., `content/docs/v2/2.13/`; replace `2.13` with the latest version | |
| directory) so changes appear immediately on the live site |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
redundant, everything is already stated above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot was not doing what was expected. After putting this here the agent was following instructions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will consolidate it.