Skip to content

Filled out docs for contributions.md#835

Merged
Matthew-Dobson merged 7 commits into
mainfrom
831-more-documentation-for-new-developers
Nov 6, 2025
Merged

Filled out docs for contributions.md#835
Matthew-Dobson merged 7 commits into
mainfrom
831-more-documentation-for-new-developers

Conversation

@Matthew-Dobson

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings November 6, 2025 10:13
@Matthew-Dobson Matthew-Dobson linked an issue Nov 6, 2025 that may be closed by this pull request
@Matthew-Dobson Matthew-Dobson requested a review from a team November 6, 2025 10:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new CONTRIBUTIONS.md file that provides comprehensive guidelines for team members on how to contribute to the project using GitHub workflows.

Key Changes

  • Added step-by-step documentation covering ticket creation, branch management, committing/pushing changes, and the PR/merging process
  • Included visual aids (screenshots) to guide contributors through the GitHub interface
  • Documented both VS Code and bash-based workflows for committing changes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTIONS.md Outdated
Comment thread CONTRIBUTIONS.md Outdated
Comment thread CONTRIBUTIONS.md Outdated
Comment thread CONTRIBUTIONS.md Outdated
Comment thread CONTRIBUTIONS.md Outdated
Matthew-Dobson and others added 5 commits November 6, 2025 10:16
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

@1Blademaster 1Blademaster left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good start, but some changes are needed. Can you use proper markdown headings and formatting for stuff instead of making the titles bold. Also don't add numbers in the titles. Can you also specify that a user can select a pre-existing ticket to work on.

Your git push command is wrong, the stuff after git push origin should be the branch name.

Generally the screenshots are good, but can you zoom out a bit and maybe draw a circle around the specific point you're trying to highlight? Having them too zoomed in doesn't show where in the window that section is.

Lastly, prerequisites aren't prerequisites, having GitHub pro is just an optional, you can add a section in asking for a review section to highlight "you may optionally request copilot for an AI review to highlight typos or whatever" (obvs word that better).

Good start tho I like it 👍

@1Blademaster

Copy link
Copy Markdown
Member

Also please rename it to CONTRIBUTING.md.

Updated the contributing guidelines to reflect changes in the workflow and improve clarity.

@1Blademaster 1Blademaster left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

@Matthew-Dobson Matthew-Dobson merged commit dc8d490 into main Nov 6, 2025
5 checks passed
@Matthew-Dobson Matthew-Dobson deleted the 831-more-documentation-for-new-developers branch November 6, 2025 14:00
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.

More documentation for new developers

3 participants