docs: improve contributing.md guidelines#1081
Open
msgem0523 wants to merge 2 commits into
Open
Conversation
Contributor
|
@msgem0523 is attempting to deploy a commit to the vetswhocode-web-app Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates contributor-facing documentation to better guide new developers through setup and contribution workflows, and removes personal UI theming from the shared VS Code workspace settings.
Changes:
- Expanded
contributing.mdwith step-by-step local setup, workflow guidance, PR checklist, commit message rules, and testing expectations. - Cleaned up
.vscode/settings.jsonby removing workbench color customizations / Peacock color settings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| contributing.md | Major rewrite/expansion of contribution and setup guidance; includes new sections and checklists (but contains several typos, formatting issues, and some tooling/link inconsistencies). |
| .vscode/settings.json | Removes editor theming customizations to keep workspace settings focused on shared dev configuration. |
Comments suppressed due to low confidence (1)
contributing.md:154
- This section says the project uses Prettier and ESLint, but the repo scripts/config use Biome (
biome.json,npm run lintrunsbiome lint). Update the tooling references (and the suggested commands, if needed) so contributors follow the actual formatter/linter used in this codebase.
## Code Style and Linting
- We use [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) for code styling and linting. Make sure your code adheres to our configurations.
- Run the linter before submitting a PR to ensure your code passes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [Code of Conduct](#code-of-conduct) | ||
| - [Getting Started](#getting-started) | ||
| - [Fork and Clone the Repository](#fork-and-clone-the-repository) | ||
| - [Fining Issues to Work on](#fining-issues-to-work-on) |
Comment on lines
+62
to
+66
| 5. Set up environment variables: | ||
| ```bash | ||
| cp .env.example .env.local | ||
| ``` | ||
| Update .env.local with the required values. Check the README for configuration details |
| npm run dev | ||
| ``` | ||
|
|
||
| ## Fining Issues to Work on |
Comment on lines
+89
to
+91
| Before opening a bug report: | ||
| -Search existing issues to make sure the bug has not already been reported. | ||
| If it has not been reported, open a new issue. |
| - Check if the feature has already been requested. | ||
| - If it hasn't, open a new Issue with a clear title and detailed description of the feature you'd like to see. | ||
| Before requesting a feature: | ||
| -Check existing issues to see if the feature has already been suggested. |
| git push origin feature/your-feature-name | ||
| ``` | ||
|
|
||
| 2. Opena Pull Request against the original repository. |
Comment on lines
+144
to
+148
| - Code follows the project style guidlines | ||
| - Tests pass locally | ||
| - New code has tests when needed | ||
| - Documentation has now been upgraded when needed | ||
| - Commit message follow project conventions |
| If you have any questions or need further assistance: | ||
| - Open an issue | ||
| - Check existing Issues and Pull Requests | ||
| - Reach out to [Jerome Hardaway][https://github.com/jeromehardaway]. |
jeromehardaway
requested changes
May 7, 2026
Contributor
jeromehardaway
left a comment
jeromehardaway
left a comment
There was a problem hiding this comment.
Asked for a few changes, other than that good work!
|
|
||
| 1. Create a new branch for your work: | ||
| ```bash | ||
| git checkout -b feature/your-feature-name |
Contributor
There was a problem hiding this comment.
Can we have it so you say the label/username/issue
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.
Summary
Improved and expanded the CONTRIBUTING.md file to provide clearer guidance for new contributors.
Changes Made
Why This Matters
These updates makes it easier for new contributors to understand how to set up the project, follow the practices, and contribute effectively.
Testing