momoapi-python icon indicating copy to clipboard operation
momoapi-python copied to clipboard

Add a CONTRIBUTING guide

Open raybesiga opened this issue 6 years ago • 7 comments

Need to add a contributing guide

raybesiga avatar Mar 12 '19 12:03 raybesiga

Do you plan to include details on developer setup in the contribution guide?

Like how to setup for development.

nanjekyejoannah avatar Mar 18 '19 09:03 nanjekyejoannah

Hi @nanjekyejoannah have you read through the README?

raybesiga avatar Mar 18 '19 09:03 raybesiga

@raybesiga yes I have. The setup for development is a section with details like. get the code ..run tests..run one test etc

You have a section for running tests. The readme IMHO looks more like to a user of the package not a developer/contributor.

I was also thinking, a docs folder may be? most projects have a readme and separate documentation. Again this decision is made by maintainer and w just follow.

nanjekyejoannah avatar Mar 18 '19 11:03 nanjekyejoannah

@nanjekyejoannah appreciate your feedback. As you can see, we only just opened this issue 6 days ago. We shall work on a contributing guide and you will be the first to know. We look forward to your contributions! Best regards.

raybesiga avatar Mar 18 '19 12:03 raybesiga

Hi @nanjekyejoannah please find a link to the update contributing guide here. Thank you for your patience.

raybesiga avatar Mar 28 '19 09:03 raybesiga

Thanks @raybesiga . Its what I envisioned. I can close this I guess. Also I will find time to contribute to some work on this project. If you have any burning open issues I can help with...do tell.

nanjekyejoannah avatar Mar 30 '19 15:03 nanjekyejoannah

That is great to hear @nanjekyejoannah. We may have blind spots and could use contributions both for bugs, as well as enhancements and feature requests. Open a ticket in case anything comes to mind.

raybesiga avatar Apr 01 '19 06:04 raybesiga