Move contributing guide to CONTRIBUTING.md
This commit is contained in:
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal file
@@ -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!
|
||||||
29
README.md
29
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'}
|
{'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
|
## 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
|
### Requirements
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user