diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000000..4395a2a4ee5 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,64 @@ + +# AGENTS.md for Apache Solr + +While README.md and CONTRIBUTING.md are mainly written for humans, this file is a condensed knowledge base for LLM coding agents on the Solr codebase. See https://agents.md for more info and how to make various coding assistants consume this file. Also see `dev-docs/how-to-contribute.adoc` for some guidelines when using genAI to contribute to Solr. + +## Licensing and Dependencies + +- Follow Apache Software Foundation licensing rules, avoid adding a dependency with a banned license +- Always apply the Apache License to new source files +- All versions must be delcared in `gradle/libs.versions.toml`, never build.gradle files +- Try first declaring a dependency without a version (the version might already be in a BOM); and if fails to resolve _then_ specify a version +- The build may complain with "Dependency analysis found issues.", a category like "usedUndeclaredArtifacts", and a dependency list. Declare or undeclare these dependencies, as the category will imply. The special 'permit*' configurations are a choice of last resort. +- Always run `gradlew updateLicenses resolveAndLockAll --write-locks` after adding or changing a dependency. See `dev-docs/gradle-help/dependencies.txt` for more info + +## Build and Development Workflow + +- When done or preparing to commit changes to java source files, be sure to run `gradlew tidy` to format the code +- Always run `gradlew check -x test` before declaring a feature done + +## Code Quality and Best Practices + +- Use the project's custom `EnvUtils` to read system properties. It auto converts env.var SOLR_FOO_BAR to system property solr.foo.bar +- Be careful to not add non-essential logging! If you add slf4j log calls, make sure to wrap debug/trace level calls in `logger.isXxxEnabled()` clause +- Validate user input. For file paths, always call `myCoreContainer.assertPathAllowed(myPath)` before using + +## Testing + +- When adding a test to an existing suite/file, keep the same style / design choices +- When adding a *new* Java test suite/file: + - Subclass SolrTestCase, or if SolrCloud is needed then SolrCloudTestCase + - If SolrTestCase and need to embed Solr, use either EmbeddedSolrServerTestRule (doesn't use HTTP) or SolrJettyTestRule if HTTP/Jetty is relevant to what is being tested. + - Avoid SolrTestCaseJ4 for new tests + +- See `dev-docs/gradle-help/tests.txt` for hints on running tests + +## Documentation + +- For major or breaking changes, add a prominent note in reference guide major-changes-in-solr-X.adoc +- Always consider whether a reference-guide page needs updating due to the new/changed features. Target audience is end user +- For changes to build system and other developer-focused changes, consider updating or adding docs in dev-docs/ folder +- Keep all documentation including javadoc concise +- New classes should have some javadocs +- Changes should not have code comments communicating the change, which are instead great comments to leave for code review / commentary + +## Changelog + +- We use the "logchange" tooling to manage our changelog. See `dev-docs/changelog.adoc` for details and conventions +- To scaffold a new changelog entry, run `gradlew writeChangelog`, and then edit the new file located in `changelog/unreleased/`. +- Do not add a changelog entry before a JIRA issue or a Github PR is assigned, as one is required. diff --git a/dev-docs/how-to-contribute.adoc b/dev-docs/how-to-contribute.adoc index fdd60619d28..4ff6edeaae5 100644 --- a/dev-docs/how-to-contribute.adoc +++ b/dev-docs/how-to-contribute.adoc @@ -64,8 +64,9 @@ In order to make a new contribution to Solr you will use the fork you have creat ## Use of AI Coding Assistants -AI-powered tools (like GitHub Copilot, ChatGPT, etc.) can assist with contributions, but human contributors remain fully responsible for all submitted code and documentation. See the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for the foundation's policy. If you use AI tools: +AI-powered tools or agents (like GitHub Copilot, ChatGPT, etc.) can assist with contributions, but human contributors remain fully responsible for all submitted code and documentation. See the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for the foundation's policy. If you use AI tools: +- Do include our `AGENTS.md` file in the LLM's context for best result. - Carefully review all generated content for correctness, security, and alignment with Solr's architecture - For major AI-assisted contributions, disclose the use of AI tools in your PR description - For documentation contributions, prefer concise, human-readable content over verbose AI-generated text