docs: add CONTRIBUTING.md guidelines - #7
Open
lucumango wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new CONTRIBUTING.md to standardize how contributors set up the project locally, work with Git/PRs, and meet testing + code-quality expectations for mwCore (addresses Issue #6).
Changes:
- Document local dev environment setup using
uv - Define recommended Git workflow + Conventional Commit prefixes
- Describe testing/verification expectations and general code-quality guidance
💡 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.
|
|
||
| ## 4. Code Quality | ||
|
|
||
| While we don't have automated pre-commit hooks currently running, please ensure your code is readable, documented with docstrings, and follows standard PEP8 conventions as much as possible. |
Comment on lines
+17
to
+20
| git clone https://github.com/barrydoooit/mwCore.git | ||
| cd mwCore | ||
| uv sync --all-extras | ||
| ``` |
| We use [`uv`](https://github.com/astral-sh/uv) to manage dependencies and virtual environments. | ||
|
|
||
| ### Prerequisites | ||
| 1. Install Python 3.10+. |
| @@ -0,0 +1,47 @@ | |||
| # Contributing to mwCore | |||
|
|
|||
| First off, thank you for considering contributing to `mwCore`! It's people like you that make `mwCore` a central, robust tool for TI mmWave radar research and robot navigation. | |||
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.
Description
Adds standard contribution guidelines to the repository. Includes setup steps with
uv, git workflow, testing requirements, and commit message conventions.Resolves #6