poolboy icon indicating copy to clipboard operation
poolboy copied to clipboard

Improvements to Project's README Introduction

Open pollysobeck opened this issue 6 years ago • 0 comments

Hello,

After taking a look at poolboy's README, I think this project could benefit from a more detailed introduction and mission statement on what the software accomplishes. This would greatly help with drawing in new contributors or people who may be less familiar with how pooling libraries work.

One thing that would also be helpful in this regard would be including a more detailed description on how using this software could be beneficial in different scenarios, as jumping straight into code may not necessarily give a new contributor this information.

This documentation on open source projects may be helpful in terms of how to draw in users with a strong mission statement and introduction. https://producingoss.com/en/getting-started.html#mission-statement

Thank you for taking the time to read this!

NOTE: This improvement idea was discovered during a gender inclusivity project that was performed on this project for an open source course.

pollysobeck avatar May 18 '19 17:05 pollysobeck