Chore/generic pr template and docs cleanup#77
Merged
ArchILLtect merged 2 commits intomainfrom Dec 22, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new general-purpose GitHub issue template and improves documentation clarity across multiple files. The changes focus on reducing redundancy, fixing formatting issues, and making documentation more portable and maintainable.
- Added a flexible
.github/ISSUE_TEMPLATE/general.ymlfor miscellaneous issues, reviews, and feedback - Cleaned up duplicate text and improved readability in project documentation
- Replaced hardcoded local file paths with portable placeholders in build instructions
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/general.yml |
New general-purpose issue template with dropdown for issue type and structured fields for summary, details, context, and attachments |
docs/week-7-issues.md |
Removed duplicated text fragments in the scope sections that were erroneously concatenated |
docs/projects/mvp/README.md |
Replaced hardcoded local file paths with [project-root] placeholder in Maven commands and reorganized Quick Start section for better flow |
TODO.md |
Fixed item numbering, added proper backticks around GitHub action references for consistent code formatting |
README.md |
Consolidated redundant sentences about project goals into a single, clearer statement emphasizing CodeForge as a simpler alternative |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request introduces a new general-purpose GitHub issue template and makes several documentation improvements for clarity and maintainability. The main changes include adding a flexible issue template, updating quick start instructions for the MVP project, and refining language in the README and project docs.
Issue Template Addition:
.github/ISSUE_TEMPLATE/general.ymlto provide a generic issue template for reviews, feedback, questions, and general requests. This template includes dropdowns for type, summary, details, context, and attachments to standardize issue reporting.Documentation Improvements:
README and Project Docs:
README.mdto clarify the project's goals and simplify language, emphasizing CodeForge as a simpler, clarity-first alternative to other coding platforms. [1] [2]docs/projects/mvp/README.mdby replacing hardcoded local file paths with[project-root]placeholders for build and test commands, making them more portable. [1] [2]docs/week-7-issues.mdby removing duplicate lines and improving readability.docs/projects/mvp/README.mdfor better onboarding.TODO List:
TODO.mdfor tasks related to PR labeling and controller advice, and fixed code formatting for referenced GitHub Actions. [1] [2]