gocelery-129 Added a very basic contributing guide #130
Conversation
|
Resolves 129 |
|
Thank you for the PR. |
|
|
||
| * To get the latest changes from the forked repository [setup the upstream master](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork) and [sync](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) often | ||
|
|
||
| ### Installing for Local Development |
There was a problem hiding this comment.
I think we should document integration testing process instead of a local build. You can describe a process of running example/goworker/main.go and example/goclient/main.go to ensure things are working properly. Also test section should precede this section.
| @@ -203,11 +203,6 @@ Celery Message Protocol Version 1 | |||
|
|
|||
| Please let us know if you use gocelery in your project! | |||
|
|
|||
| ## Contributing | |||
There was a problem hiding this comment.
There should be a link to CONTRIBUTING.md
| @@ -0,0 +1,35 @@ | |||
| ## Contributing | |||
There was a problem hiding this comment.
This file should be named CONTRIBUTING.md
| You are more than welcome to make any contributions. | ||
| Please create Pull Request for any changes. | ||
|
|
||
| ### Fork the Repository |
There was a problem hiding this comment.
This should be setting up development environment instead. You should also mention third party brokers/backends that need to be installed here.
|
|
||
| ### Running the tests | ||
|
|
||
| 1. [Install Redis](https://redis.io/download) |
There was a problem hiding this comment.
This should be moved up as per earlier comment.
|
You should also squash your commits into one. |
Added a basic contributing guide with install and setup instructions. Happy to tweak any wording or add detail where it is needed