Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/atr-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# 3. Request ATR onboarding from dev@tooling.apache.org
#
# STATUS: Workflow is ready but prerequisites are not met
# See: dev-docs/ATR_TESTING_GUIDE.md for complete implementation path
# See: docs/development/ATR_TESTING_GUIDE.md for complete implementation path
#
# WHEN TO USE:
# -----------
Expand Down
51 changes: 29 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ Thank you for your interest in contributing to the Solr MCP Server! This documen

## Developer documentation

To avoid duplication, the environment setup, build/run/test workflows, and detailed developer guides live in the dev-docs folder:
To avoid duplication, the environment setup, build/run/test workflows, and detailed developer guides live in the [docs/development](docs/development) folder:

- Development Guide (build, run, test, IDE, CI): dev-docs/DEVELOPMENT.md
- Architecture: dev-docs/ARCHITECTURE.md
- Deployment (Docker, HTTP vs STDIO): dev-docs/DEPLOYMENT.md
- Troubleshooting: dev-docs/TROUBLESHOOTING.md
- [Development Guide](docs/development/DEVELOPMENT.md) -- build, run, test, IDE, CI
- [Architecture](docs/development/ARCHITECTURE.md) -- project structure and design decisions
- [Deployment](docs/development/DEPLOYMENT.md) -- Docker, HTTP vs STDIO
- [Troubleshooting](docs/development/TROUBLESHOOTING.md) -- common issues and solutions

If you're ready to contribute code, see Submitting Changes below.
If you're ready to contribute code, see [Submitting Changes](#submitting-changes) below.

## Code Style and Quality

We use Spotless for code formatting and style enforcement. CI enforces `spotlessCheck` on pull requests.

- Commands and details: dev-docs/DEVELOPMENT.md#common-gradle-tasks
- Build system overview: dev-docs/DEVELOPMENT.md#build-system
- [Commands and details](docs/development/DEVELOPMENT.md#common-gradle-tasks)
- [Build system overview](docs/development/DEVELOPMENT.md#build-system)

### Coding Standards

Expand All @@ -32,11 +32,11 @@ We use Spotless for code formatting and style enforcement. CI enforces `spotless

To keep this document concise, please see the Development Guide for all testing workflows and tips:

- Testing overview: dev-docs/DEVELOPMENT.md#testing
- Unit tests: dev-docs/DEVELOPMENT.md#unit-tests
- Integration tests: dev-docs/DEVELOPMENT.md#integration-tests
- Docker image tests: dev-docs/DEVELOPMENT.md#docker-integration-tests
- Coverage reports: dev-docs/DEVELOPMENT.md#testing
- [Testing overview](docs/development/DEVELOPMENT.md#testing)
- [Unit tests](docs/development/DEVELOPMENT.md#unit-tests)
- [Integration tests](docs/development/DEVELOPMENT.md#integration-tests)
- [Docker image tests](docs/development/DEVELOPMENT.md#docker-integration-tests)
- [Coverage reports](docs/development/DEVELOPMENT.md#testing)

## Publishing to Maven Local

Expand Down Expand Up @@ -131,21 +131,28 @@ test: add integration tests for collection service

For implementation details and examples, see the Development Guide:

- Adding new MCP tools: dev-docs/DEVELOPMENT.md#adding-a-new-mcp-tool
- Adding a new document format: dev-docs/DEVELOPMENT.md#adding-a-new-document-format
- Project structure and architecture: dev-docs/ARCHITECTURE.md
- Dependencies and version catalogs: dev-docs/DEVELOPMENT.md#build-system
- Documentation practices: dev-docs/DEVELOPMENT.md#modifying-configuration
- [Adding new MCP tools](docs/development/DEVELOPMENT.md#adding-a-new-mcp-tool)
- [Adding a new document format](docs/development/DEVELOPMENT.md#adding-a-new-document-format)
- [Project structure and architecture](docs/development/ARCHITECTURE.md)
- [Dependencies and version catalogs](docs/development/DEVELOPMENT.md#build-system)
- [Documentation practices](docs/development/DEVELOPMENT.md#modifying-configuration)

## Security Setup (HTTP Mode)

For OAuth2 configuration with supported providers:

- [Auth0 Setup Guide](docs/development/AUTH0_SETUP.md)
- [Keycloak Setup Guide](docs/development/keycloak.md)

## Questions or Need Help?

- Open an issue for bugs or feature requests
- Start a discussion for questions or ideas
- Check existing issues and discussions first
- **Slack:** [`#solr-mcp`](https://the-asf.slack.com/archives/C09TVG3BM1P) in the `the-asf` workspace
- **Issues:** [GitHub Issues](https://github.com/apache/solr-mcp/issues) for bugs or feature requests
- **Mailing lists:** Shared with Apache Solr -- see [mailing lists](https://solr.apache.org/community.html#mailing-lists-chat)

## Code of Conduct

Be respectful, inclusive, and professional. We're all here to build something great together.
As an Apache project, we follow the [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct).

## License

Expand Down
Loading