I’ve been happily using Julia for 3-4 years and would like to try contributing to other packages than my own however
- I often don’t really know how to (I do know how to make a PR but not up to what extent it’s ok to suggest a PR for an example or a comment for a use-case etc), many repos seem to lack a “CONTRIBUTING” file & where some maintainers may be happy with newbie (clumsy) modifications, I could understand others not being too happy about it, so having a file to guide people could be useful. Having a list of things that need be looked at would also be useful.
- I often don’t know where to ask usage questions / comments. Issues seem inappropriate because they usually relate to the code itself, email would be overkill for maintainers, discourse can be good but it feels far from the repo, slack is too short-lived and Stack Overflow can be a bit scary for “simple” questions and feels inappropriate for comments / discussion.
Maybe it’d be good to suggest general Julia guidelines for package devs & users to collaborate better? for example
- recommend there be a friendly “CONTRIBUTING.md” doc on all repos, maybe add a “walk-through-first-PR” somewhere in the julia universe (maybe it exists and I haven’t seen it). There’s scattered resources on how to create and register a package (e.g. by Chris R ) but I couldn’t find a kind of “suggested checklist” that would for example include adding a contrib file or good practices. Maybe that
PkgDev.jlcould generate a template contrib file like it does with the license.
- not sure about the second one (and it may have already been discussed elsewhere): maybe a way around is to suggest that Julia repos do indeed use “issues” for usage questions/comments (possibly with a
usagelabel) allowing not only the maintainer but also other users to reply which would then eventually form a kind of repo FAQ and lead to PR with usage examples.