From b891d257f6c3505e57ea9ab481c83089af5fc33c Mon Sep 17 00:00:00 2001 From: boukeversteegh Date: Thu, 9 Jul 2020 00:16:36 +0200 Subject: [PATCH 1/3] Updated readme with contribution section. More help welcome :smiley: --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d1facad..39fd685 100644 --- a/README.md +++ b/README.md @@ -302,6 +302,32 @@ datetime.datetime(2019, 1, 1, 11, 59, 58, 800000, tzinfo=datetime.timezone.utc) {'ts': '2019-01-01T12:00:00Z', 'duration': '1.200s'} ``` + +## Contribution + + +Join us on [Slack](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ)! + +There's lots to do, and we're working hard, so any help is welcome! + +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 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! + ## Development Join us on [Slack](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ)! @@ -434,10 +460,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 From 8d7d0efb9b689ad467e33946c85a6a58e06fe4ff Mon Sep 17 00:00:00 2001 From: boukeversteegh Date: Thu, 9 Jul 2020 09:31:04 +0200 Subject: [PATCH 2/3] Move contributing guide to CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ README.md | 29 ++--------------------------- 2 files changed, 25 insertions(+), 27 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f54a9aa --- /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 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! \ No newline at end of file diff --git a/README.md b/README.md index 39fd685..d1cd13f 100644 --- a/README.md +++ b/README.md @@ -302,35 +302,10 @@ datetime.datetime(2019, 1, 1, 11, 59, 58, 800000, tzinfo=datetime.timezone.utc) {'ts': '2019-01-01T12:00:00Z', 'duration': '1.200s'} ``` - -## Contribution - - -Join us on [Slack](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ)! - -There's lots to do, and we're working hard, so any help is welcome! - -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 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! - ## 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 From 5a591ef2a423b9bc9570a4725e6de0de36ba7ff5 Mon Sep 17 00:00:00 2001 From: nat Date: Thu, 9 Jul 2020 20:41:13 +0200 Subject: [PATCH 3/3] Add link to testing README in CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f54a9aa..9bd43ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,9 +15,9 @@ What can you do? - File a bug (please check its not a duplicate) - Propose an enhancement - :white_check_mark: Create a PR: - - Creating a failing test-case to make bug-fixing easier + - [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! \ No newline at end of file + - If you'd like to discuss your idea first, join us on Slack!