📝 Docs: Streamline Contributing, Issue, PR and Architecture Documentation#4613
Open
MrAdder wants to merge 6 commits intoVATSIM-UK:mainfrom
Open
📝 Docs: Streamline Contributing, Issue, PR and Architecture Documentation#4613MrAdder wants to merge 6 commits intoVATSIM-UK:mainfrom
MrAdder wants to merge 6 commits intoVATSIM-UK:mainfrom
Conversation
5 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation refresh to streamline contributor workflow guidance and capture the refactor-era architecture/testing standards in a single, scannable set of docs/templates.
Changes:
- Add an architecture guide and link it from the repo README.
- Expand and standardize the issue/PR templates with type, verification, manual validation, and risk prompts.
- Rewrite CONTRIBUTING to clarify scope, workflows, architecture expectations, and testing/refactor guidance.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| readme.md | Adds a link to the architecture guide under Getting Started. |
| docs/architecture.md | Introduces a concise architecture standards guide (layers, queues/jobs, webhooks, providers, testing). |
| .github/PULL_REQUEST_TEMPLATE.md | Updates PR template to include change type, verification, manual validation, and risk assessment. |
| .github/ISSUE_TEMPLATE.md | Expands issue template to capture type, problem statement, current/expected behavior, and verification plan. |
| .github/CONTRIBUTING.md | Rewrites contributing guide with scope, workflows, architecture/testing expectations, and refactor guidelines. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Removed the step to create a branch named 'issue-[issue_number]' from the pull request workflow.
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.
Fixes #4550
Summary of Changes
Slims down and aligns the contributing and documentation files with the ongoing refactor initiative.
Type of Change
Verification
Manual Validation
Reviewed all four files for accuracy, consistency, and alignment with the refactor patterns established in #4545, #4549, #4559, and #4577. No functional code was changed.
Risk Assessment
Documentation-only changes. No risk of regressions.