janhoy commented on code in PR #4103: URL: https://github.com/apache/solr/pull/4103#discussion_r2768718370
########## AGENTS.md: ########## @@ -0,0 +1,55 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> +# AGENTS.md for Apache Solr + +While README.md and CONTRIBUTING.md are mainly written for humans, this file is a condensed knowledge base for coding agents on the Solr codebase. For background, see https://agents.md + +## 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 +- We use gradle version-catalog toml file to encode dependency versions, never add versions directly to build.gradle files +- We use the "cutterslade-analyze" plugin which requires explicit recording of all dependencies in a build.gradle file +- 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 + +- Always run "gradlew tidy" after editing files +- Always run "gradlew check -x test" before declaring a feature done +- Respect our .editorconfig + +## 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 +- If you add slf4j log calls, make sure to wrap in logger.isXxxEnabled() clause. Be careful to not add unnecessary logging Review Comment: When is it NOT required to wrap a log call? Is it only when it is a costly one? Yea, it will catch its own error once it runs precommit check, but this was an attempt to make it aware of the requirement. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
