diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9bd43ec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +There's lots to do, and we're working hard, so any help is welcome! + +- :speech_balloon: Join us on [Slack](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ)! + +What can you do? + +- :+1: Vote on [issues](https://github.com/danielgtaylor/python-betterproto/issues). +- :speech_balloon: Give feedback on [Pull Requests](https://github.com/danielgtaylor/python-betterproto/pulls) and [Issues](https://github.com/danielgtaylor/python-betterproto/issues): + - Suggestions + - Express approval + - Raise concerns +- :small_red_triangle: Create an issue: + - File a bug (please check its not a duplicate) + - Propose an enhancement +- :white_check_mark: Create a PR: + - [Creating a failing test-case](https://github.com/danielgtaylor/python-betterproto/blob/master/betterproto/tests/README.md) to make bug-fixing easier + - Fix any of the open issues + - [Good first issues](https://github.com/danielgtaylor/python-betterproto/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) + - [Issues with tests](https://github.com/danielgtaylor/python-betterproto/issues?q=is%3Aissue+is%3Aopen+label%3A%22has+test%22) + - New bugfix or idea + - If you'd like to discuss your idea first, join us on Slack! diff --git a/README.md b/README.md index d1facad..d1cd13f 100644 --- a/README.md +++ b/README.md @@ -304,7 +304,8 @@ datetime.datetime(2019, 1, 1, 11, 59, 58, 800000, tzinfo=datetime.timezone.utc) ## Development -Join us on [Slack](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ)! +- _Join us on [Slack](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ)!_ +- _See how you can help → [Contributing](CONTRIBUTING.md)_ ### Requirements @@ -434,10 +435,10 @@ protoc \ - [x] Enum strings - [x] Well known types support (timestamp, duration, wrappers) - [x] Support different casing (orig vs. camel vs. others?) -- [ ] Async service stubs +- [x] Async service stubs - [x] Unary-unary - [x] Server streaming response - - [ ] Client streaming request + - [x] Client streaming request - [x] Renaming messages and fields to conform to Python name standards - [x] Renaming clashes with language keywords - [x] Python package