Skip to content

Conversation

@viiccwen
Copy link
Contributor

@viiccwen viiccwen commented Jan 22, 2026

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

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

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

@guan404ming
Copy link
Member

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?

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Unified Contributing Documentation

3 participants