Add contributing file

[sanders41]

Discussed in #30

Since the goal was simple and concise I decided not to add specific instructions for installing pre-commit, running tests etc. If you think it is too concise I can add that in.

[sanders41]

This also ended up being the first test of the pre-commit.ci setup and it ran without issue 🎉

[prrao87]

Love it, looks great!

[prrao87]

I agree with you, adding the Rust/Python formatting guidelines are necessary because a lot of people will never have worked pre-commit.yml and the likes before (and they may not even have it installed).

[sanders41]

I added a section on using pre-commit. Let me know if these instructions explain it well for a new user to pre-commit.

[prrao87]

LGTM! I think we should also add a small paragraph stating that it's recommended to run cargo clippy and cargo fmt prior to submitting a PR (or just use our Makefile with make all) so that the initial PR doesn't fail CI from a formatting perspective.

[sanders41]

I think we should also add a small paragraph stating that it's recommended to run cargo clippy and cargo fmt prior to submitting a PR (or just use our Makefile with make all) so that the initial PR doesn't fail CI from a formatting perspective.

Do you mean on a per piece level or on the overall project level? I considered adding this at the project level, but didn't because compiles will fail with sqlx if the database isn't running.

[prrao87]

Do the pre-commit checks work for everything, including Rust? I see that it runs ruff format and ruff --fix for imports in Python, but what about if someone contributes unformatted Rust code? That should also be covered, correct? If not, then we're setting people up for the CI to fail on the first commit as it's perfectly likely that they forget to run cargo fmt like I did.

[prrao87]

I think just a simple guideline after the Python section like "If committing Rust code, make sure to run Cargo's clippy and fmt so that linting is respected". Sometimes, that isn't common knowledge for certain folks.

[sanders41]

This answer is a bit tricky because of sqlx 😄. pre-commit can run the rust checks but we don't have them in there right now. At one time I was having an issue with pre-commit running these in CI, but that was a while ago so it may be fixed. The bigger issue is clippy will fail if run with pre-commit unless the database is running. I believe the rust formatter can run without sqlx complaining so I'll experiment with adding that into pre-commit.

I'll also add a section on running the formatters on added/changed code.

[prrao87]

Ahh I understand now. Thanks for clarifying. I'm good with whatever you suggest on that front then, feel free to merge when done!

[prrao87]

Great!