Filled out docs for contributions.md#835
Conversation
There was a problem hiding this comment.
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.
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
left a comment
There was a problem hiding this comment.
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 👍
|
Also please rename it to |
Updated the contributing guidelines to reflect changes in the workflow and improve clarity.
No description provided.