Chore/generic pr template and docs cleanup #77
Merged
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]