Add CONTRIBUTING.md#89
Open
arpitjain099 wants to merge 4 commits into
Open
Conversation
Signed-off-by: arpitjain099 <arpitjain099@gmail.com>
elliott-ruebush
left a comment
elliott-ruebush
left a comment
Collaborator
There was a problem hiding this comment.
good idea! I'm going to look at updating this PR and potentially adding an AGENTS.md as well.
CONTRIBUTING defers setup to the README and style to AGENTS.md. AGENTS.md documents repo layout, science-vs-plumbing conventions, and testing patterns. Co-authored-by: Cursor <cursoragent@cursor.com>
|
|
||
| ## Setup | ||
|
|
||
| Install as described in the [README](README.md#installation). Use `pip install -e ".[dev]"` to include test tools. |
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
2 participants
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.
No contributor guidelines exist yet. Adds a basic CONTRIBUTING.md covering dev setup, running tests, and PR expectations.