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

Improvements to Project's README Introduction #128

Open
pollysobeck opened this issue May 18, 2019 · 0 comments
Open

Improvements to Project's README Introduction #128

pollysobeck opened this issue May 18, 2019 · 0 comments

Comments

@pollysobeck
Copy link

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.

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

1 participant