Lowering contribution barrier #479
Becheler
started this conversation in
Documentation & Onboarding
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Story
A newcomer or a researcher asking "how do I add an algorithm to BGL?" has no documented answer in this repo.
The entrance bar is already high: BGL's design is heavily generic (algorithms are coded against concepts, not concrete graph types), the historical documentation is sparse, and the contribution process is undocumented. The generic design is a core constraint we can't remove, but we can remove some of the process friction and pain points.
Concretely, the repo has:
CONTRIBUTING.md.github/CONTRIBUTING.mdA newcomer falls back to generic Boost-wide resources (the boostorg wiki, the Boost mailing list, the general boost+git workflow), none of which is BGL-specific.
Researchers come with additional context and frictions: they are not developers, their job is to submit papers, not to figure out
b2, cmake, generic C++ and Boost idioms. BGL needs researchers and researchers need BGL. A process must exist for researchers and developers to communicate.Dream solution
Meet newcomers and researchers where their incentives already are.
Starting point
Intermediary objective
Identify highest friction points to new contributions and draft possible solutions. Any idea is welcome, or pick one:
Beta Was this translation helpful? Give feedback.
All reactions