Create CONTRIBUTING.md with contributor guidelines#384
Merged
thomasturrell merged 2 commits intomainfrom Nov 18, 2025
Merged
Conversation
Co-authored-by: thomasturrell <1552612+thomasturrell@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Draft CONTRIBUTING.md for improved project contribution guidelines
Create CONTRIBUTING.md with contributor guidelines
Nov 18, 2025
thomasturrell
approved these changes
Nov 18, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR creates a comprehensive CONTRIBUTING.md document that consolidates scattered contributor guidelines from README.md, establishing a single source of truth for development workflows and contribution processes.
Key Changes:
- Created detailed CONTRIBUTING.md (338 lines) covering prerequisites, development workflow, code patterns, PR process, project structure, and quality gates
- Streamlined README.md by removing 22 lines of duplicated content (Java installation, code quality tools) and replacing with references to CONTRIBUTING.md
- Enhanced the Contributing section in README.md with structured bullet points linking to specific CONTRIBUTING.md sections
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | New comprehensive contributor guide covering Java 25 setup, build/test procedures, code style enforcement (CheckStyle/Google Java Style Guide), PR workflow, project structure, and integration with SonarCloud/CodeQL |
| README.md | Removed duplicated Java installation instructions and code quality tool descriptions; replaced Contributing section with structured links to CONTRIBUTING.md sections |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
Resolves #(issue)
Created comprehensive CONTRIBUTING.md consolidating contributor guidelines scattered across README.md. Removed duplicated content from README to maintain single source of truth.
Changes
CONTRIBUTING.md (new): 338-line document covering:
README.md: Removed 22 lines of duplicated content:
Structure
Checklist:
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.