Skip to content

Commit

Permalink
Format readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shabbyrobe committed Sep 29, 2023
1 parent b2d5e65 commit efe2de6
Showing 1 changed file with 26 additions and 21 deletions.
47 changes: 26 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,44 +28,49 @@ you supply an MRE as per the contributing guidelines below.

### Minimum Reproducible Examples (MRE)

Unfortunately, due to the fussy nature of `grpc` and its dependencies, and the huge amount of time
required to construct a context in which to verify and debug issues, starting from 2022-04-16, fairly strict issue and
pull request templates have been added.
Unfortunately, due to the fussy nature of `grpc` and its dependencies, and the
huge amount of time required to construct a context in which to verify and
debug issues, starting from 2022-04-16, fairly strict issue and pull request
templates have been added.

Minimum Reproducible Examples are now a hard requirement for pull requests that touch the typing surface,
and a soft requirement for issues. PRs without a functioning MRE transfer the burden entirely from the
contributor to the maintainer, and I simply don't have time to do the deep-dives required to build out MREs
from scratch when issues inevitably crop up. PRs without a trivially executable MRE will be closed without further
consideration; of course you are always welcome to reopen once you have added a verified MRE!
Minimum Reproducible Examples are now a hard requirement for pull requests that
touch the typing surface, and a soft requirement for issues. PRs without a
functioning MRE transfer the burden entirely from the contributor to the
maintainer, and I simply don't have time to do the deep-dives required to build
out MREs from scratch when issues inevitably crop up. PRs without a trivially
executable MRE will be closed without further consideration; of course you are
always welcome to reopen once you have added a verified MRE!


### Tests

This project uses a slightly old version of https://github.com/TypedDjango/pytest-mypy-plugins for testing.
All new contributions will be required to include at least one, but probably multiple tests. See
`typesafety/test_*.yml`.
This project uses a slightly old version of
https://github.com/TypedDjango/pytest-mypy-plugins for testing. All new
contributions will be required to include at least one, but probably multiple
tests. See `typesafety/test_*.yml`.


### Code-generated stubs

PRs containing auto-generated stubs have had to be reverted several times due to issues. Starting
from 2022-04-16, autogenerated stubs from `mypy-protobuf` will not be accepted without extensive
tests, and will not be accepted with edit warnings left in. It's ok to use this tool to seed stubs,
but not to refresh stubs - once contributed to this repo, the stubs should be presumed to have been
written by hand.
PRs containing auto-generated stubs have had to be reverted several times due
to issues. Starting from 2022-04-16, autogenerated stubs from `mypy-protobuf`
will not be accepted without extensive tests, and will not be accepted with
edit warnings left in. It's ok to use this tool to seed stubs, but not to
refresh stubs - once contributed to this repo, the stubs should be presumed to
have been written by hand.


## Calls for assistance

There are several areas where `grpc-stubs` could use some TLC. If you'd like to help with any
of this, please reach out!
There are several areas where `grpc-stubs` could use some TLC. If you'd like to
help with any of this, please reach out!


### Maintainers

It's unlikely I'll be returning to grpc full-time for the foreseeable future, and my knowledge of the
minutiae fades with each passing year. If anyone wishes to assume maintainership of this project ongoing,
please reach out.
It's unlikely I'll be returning to grpc full-time for the foreseeable future,
and my knowledge of the minutiae fades with each passing year. If anyone wishes
to assume maintainership of this project ongoing, please reach out.


## Other Very Useful Typed Python Stuff
Expand Down

0 comments on commit efe2de6

Please sign in to comment.