docs: create contributing doc

[ajbozarth]

Misc PR

Type of PR

• Bug Fix
• New Feature
• Documentation
• Other

Description

• Link to Issue: Fixes Contribution guidelines are not provided in README. #315

Moves development and contributing documentation into a standard CONTRIBUTING.md doc and updates current docs to reference it.

Also includes fixes for incorrect test commands and dir structure found while creating the doc

Testing

• Tests added to the respective file if code was changed
• New code has 100% coverage if code as added
• Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

[github-actions]

The PR description has been updated. Please fill out the template for your PR to be reviewed.

[mergify]

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

[ajbozarth]

Note that the ruff and mypy commands documented currently fail. I've opened #370 to address it in a follow up.

[ajbozarth]

@psschwei I've pushed a commit addressing all your inline comments if you'd like to take a look

[psschwei]

I know we're still working on figuring out how to best run the tests, so one question: does the way to run the tests in this PR work with the codebase now as is, or is it a suggestion of how to run the tests that we need to make changes in order to do? I don't want to merge a doc change that isn't how things work at that time, as that would throw a wrinkle when reviewing commit history in the future.

[ajbozarth]

does the way to run the tests in this PR work with the codebase now as is

Partially correct, this updates the docs to match how pytest currently work on main. The only caveat is that the suggested ruff and mypy commands will show the issues fixed #376 since they don't specify directories, but only when run directly. Pre-commit currently works since it specifies directories

[ajbozarth]

Status Update:

As far as I know this just needs review and approval and is good to merge. I've added a comment on #372 (review) that details the merge conflicts this PR would have with that one depending on which is merged first

[psschwei]

LGTM. I'll defer to @ajbozarth and @planetf1 on which PR should merge first

[ajbozarth]

Will be updating this onto latest main later today, once that is done this will be ready for final review

[ajbozarth]

I've "rebased" on main to pull in the changes in #372

@planetf1 if you could take a look at a606cc5 and make sure the updates match what you did in #372 the edits to the tutorial and README in that PR were tossed entirely in lieu of updating CONTRIBUTING.md (also probably worth double checking the changes to AGENTS)