[AURON #1805] Add contributing guidelines #1806
Merged
Conversation
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
github-actions
bot
added
the
documentation
added 2 commits
December 30, 2025 22:47
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive contributing guidelines to Apache Auron by creating a new CONTRIBUTING.md file and linking to it from the main README. The guidelines aim to help new contributors understand how to effectively contribute to the project.
Key changes:
- Created a detailed CONTRIBUTING.md with sections covering ways to contribute, development setup, building, testing, and communication guidelines
- Added a "Contributing" section to README.md with a link to the new contributing guide
- Included practical information about build tools, IDE setup, PR workflows, and code formatting requirements
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | New comprehensive contributing guide covering development setup, build instructions, PR guidelines, code style, testing, and communication channels |
| README.md | Added "Contributing" section with link to the new CONTRIBUTING.md guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
added 3 commits
December 31, 2025 07:09
Contributor
Author
|
@cxzl25 can you take another look at this? |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cxzl25
approved these changes
Jan 4, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
|
+LGTM |
cxzl25
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Which issue does this PR close?
Closes #1805
Rationale for this change
Auron is currently missing a contributing guide for new contributors
What changes are included in this PR?
New contributing guide, and a reference to it on the main README
Are there any user-facing changes?
Yes, added README
How was this patch tested?
N/A