docs(contrib): streamline contributor workflow and add issue-first approach #5
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
…proach CHANGES - Add mandatory issue-first workflow to CONTRIBUTING.md (no issue, no PR) - Streamline development setup with concise sections and clear structure - Enhance quality tools section with complete file tree for templates and prompts - Create README-dockerhub.md for Docker Hub with full GitHub links - Apply ruff formatting to src/build_index.py for code consistency - Update README.md contributing link to use "follow" instead of "see" IMPACT - Contributors must create issues before PRs, ensuring structured development - Reduced contributor friction with clearer, more organized documentation - Docker Hub users get comprehensive guidance with proper GitHub references TECHNICAL NOTES - Issue-first approach enforces best practices and improves project management - Dockerhub README maintains feature parity while adapting for external hosting - Code formatting maintains consistency across Python files
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines the contributor workflow by establishing an issue-first development approach and improving documentation clarity across multiple files.
- Introduces mandatory issue-before-PR workflow to ensure structured development
- Reorganizes CONTRIBUTING.md with clearer sections and more concise language
- Creates Docker Hub-specific README with full GitHub links for external users
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Minor language improvement changing "see" to "follow" for CONTRIBUTING.md link |
| README-dockerhub.md | New comprehensive Docker Hub documentation with full GitHub URLs and feature parity |
| CONTRIBUTING.md | Major restructure adding issue-first workflow, streamlined development setup, and reorganized quality tools section |
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.
CHANGES
IMPACT
TECHNICAL NOTES