Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a CONTRIBUTING guide #19

Open
raybesiga opened this issue Mar 12, 2019 · 7 comments
Open

Add a CONTRIBUTING guide #19

raybesiga opened this issue Mar 12, 2019 · 7 comments

Comments

@raybesiga
Copy link
Member

Need to add a contributing guide

@nanjekyejoannah
Copy link

nanjekyejoannah commented Mar 18, 2019

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

Like how to setup for development.

@raybesiga
Copy link
Member Author

Hi @nanjekyejoannah have you read through the README?

@nanjekyejoannah
Copy link

@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.

@raybesiga
Copy link
Member Author

@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
Copy link
Member Author

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

@nanjekyejoannah
Copy link

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.

@raybesiga
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants