Skip to content

MAHOUT-800: Unified CONTRIBUTING.md #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
guan404ming merged 2 commits into from
Feb 2, 2026
Merged

MAHOUT-800: Unified CONTRIBUTING.md #910

guan404ming merged 2 commits into from
Feb 2, 2026
+331 −290

Conversation

@viiccwen
Copy link
Contributor

@viiccwen viiccwen commented Jan 22, 2026 •
edited
Loading

This PR consolidates scattered development documentation into a single CONTRIBUTING.md file to improve developer onboarding and maintainability.

Related Issues or PRs

closes #909

Changes Made

  • Documentation
  • Bug fix
  • New feature
  • Refactoring
  • Test
  • CI/CD pipeline
  • Other

Breaking Changes

  • Yes
  • No

Summary of Changes

  • Moved content from qdp/DEVELOPMENT.md into CONTRIBUTING.md
  • Organized into clear sections: Prerequisites, Setup, Building, Testing, Profiling, Troubleshooting

Checklist

  • Added or updated unit tests for all changes
  • Added or updated documentation for all changes
  • Successfully built and ran all unit tests or manual tests locally
  • PR title follows "MAHOUT-XXX: Brief Description" format (if related to an issue)
  • Code follows ASF guidelines

ryankert01
ryankert01 reviewed Jan 23, 2026
View reviewed changes
Copy link
Member

@ryankert01 ryankert01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you help test the commands are working now or not? Some of it might not

@viiccwen
Copy link
Contributor Author

viiccwen commented Jan 23, 2026 •
edited
Loading

Sure, but I would like to make sure the structure of contributing docs.

@guan404ming
Copy link
Member

guan404ming commented Jan 24, 2026

Sure, but I would like to make sure the structure of contributing docs.

Sorry but I'm not really sure the "make sure" here means. Could you help explain deeply what you want to confirm?

ryankert01
ryankert01 reviewed Jan 26, 2026
View reviewed changes
Copy link
Member

@ryankert01 ryankert01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please help rebase

@guan404ming guan404ming added this to the Qumat 0.5.1 milestone Jan 29, 2026
@guan404ming
Copy link
Member

guan404ming commented Feb 1, 2026

Please help resolve the conflicts, thanks!

@guan404ming
Copy link
Member

guan404ming commented Feb 2, 2026

Gently ping! @viiccwen

@viiccwen viiccwen force-pushed the unified-contributing-docs branch from 5415f95 to 55b7432 Compare February 2, 2026 16:50
@guan404ming guan404ming merged commit 215c426 into apache:main Feb 2, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ryankert01 ryankert01 ryankert01 left review comments

@guan404ming guan404ming guan404ming approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

Qumat 0.6.0

Development

Successfully merging this pull request may close these issues.

[Docs] Unified Contributing Documentation

3 participants

@viiccwen @guan404ming @ryankert01