Development Setup
ReMe requires Python 3.11 or newer:Code Map
Use this map to find the implementation and its closest tests:Local Checks
Before submitting, run the repository checks and main unit suite:Tests using an LLM, embeddings, or an external service may need extra environment variables. If they cannot run locally, state why and describe substitute validation in the PR.
Change Requirements
- Include a reproducing regression test with a bug fix.
- Update job schemas and entrypoint tests when changing an action.
- Keep the default configuration launchable and test merge and compatibility behavior.
- Consider existing workspaces when changing files, indexes, wikilinks, or persistent schemas.
- Update the relevant page when user-visible installation, integration, stable contracts, or troubleshooting behavior changes.
- Keep implementation details in code comments and tests; do not create a manual page for every class or step.
Pull Requests
A PR should explain:- the user-observable problem and change;
- why this implementation was chosen;
- tests that were run;
- configuration, data, and compatibility impact;
- remaining limitations.
fix(search): rebuild stale link index. Keep roadmap and design discussion in Issues / Project, and publish version changes through GitHub Releases.