Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Improve docs `Contributing to Pydantic` section #441
I think there are a couple of ways to fix that:
.PHONY: full-check full-check: testcov lint mypy external-mypy docs benchmark-all
Then add a short note to contributing section about it.
A small improvement to
I agree with
There's also a few other problems like telling people to use single quotes not double.
Basically we should improve the "contributing" section in general, and tell people to run
I see the problems with benchmarking. It's indeed has to be run multiple times to get more or less acurate results. Maybe benchmarking and it's docs improvement should be a separate issue.
I don't think
I agree on benchmarking being a separate issue.
Regarding single quotes & blank, I have a modified version of black that enforces single quotes (actually it only takes a one line change). However given the acrimony over the original issue, I'm hesitant to release it. For now I think it's fine just to document this.