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

[ENH] Adding active discussions/enhancements and help wanted section to readme #273

Closed

Conversation

franklin-feingold
Copy link
Collaborator

Added an active discussions/enhancements and help wanted section to readme. This can help orient/focus the community around what is being actively discussed and where help is needed.

I captured a few for each to give an idea of how it may look. Can be expanded upon.

Note: the   is for spacing

this also carries over the twitter on readme from bids-standard#268 to keep consistency
@franklin-feingold franklin-feingold changed the title [WIP/ENH] Adding active discussions/enhancements and help wanted section to readme [ENH] Adding active discussions/enhancements and help wanted section to readme Jul 13, 2019
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think rather than advertising issues where "help is wanted" on the README, we should:

If you are concerned that the issues do not gain enough visibility, I would suggest having a brief section in the README referring to the issues page: What it is and how we use it (not only for bugs, but also discussions).

I would not add the Help Wanted and Active discussions and enhancements sections to the README: The topics listed there naturally fluctuate in terms of importance and being recently discussed or not --> the issues page is more dynamic and designed for that setup.

@franklin-feingold
Copy link
Collaborator Author

make more use of the "Help wanted" tag on the issues page

How would you propose we do this? We have help wanted tags, but currently little to no activity on those threads.

"pin" issues --> we can pin up to three dominant issues

This could perhaps work, but would these pined issues be active discussions or help wanted or both? How would these be easily differentiated, probably a tag?

having a brief section in the README referring to the issues page: What it is and how we use it (not only for bugs, but also discussions).

Ok. we can try this and evaluate.

Overall, the goal of this is to reduce the barrier to contributing and quickly be able to see where the project is at and where the efforts are currently being directed toward. This can be difficult to see for newer members of the community. I think it needs to be very clear and easy to locate. The fluctuation is fine it can be updated, but we can try having a brief explanation of issues and reevaluate.

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

Successfully merging this pull request may close these issues.

2 participants