We propose creating a series of ‘How do I do X for my project’ posts that are sent to the Maintainers list to make that list more active and prompt people to ask questions and engage with the group. We can also package this material as a cohesive guide on the wiki. Topics can include:
Initial questions to answer
- How do I get metrics for my Hyperledger project?
- How do I get more contributors for my Hyperledger project?
Future questions to answer based on interest from maintainers
- How can I recognize the contributors of my Hyperledger project?
- How can I collaborate more with other Hyperledger projects?
- How can I translate material for my Hyperledger project into other languages?
- How can I make my Hyperledger project more inclusive and diverse?
- How can I raise the visibility of my Hyperledger project to find more users?
- What obligations do maintainers have?
- What tools are available to me to maintain my project?
- How else can we help you with your 2021 goals for your Hyperledger project?
Guide/tutorial links for those that are not confident enough with their git fu to wrangle multiple conflicting branches without turning their commit graph into a merge-spaghetti
Practical "pro" tip: Take cues from other projects. Or in other words, just shamelessly copy the boilerplate stuff.
Chances are, if you see a CONTRIBUTING.md file like the Cactus one, you'll be able to re-purpose it to fit your exact needs in less effort than writing one from scratch (and the other projects have great CONTRIBUTING.md files too, but I'm shamelessly self-plugging).
- This also applies to even just figuring out what boilerplate documentation you need to begin with (repo linter might make this easy in the future but until then the simplest is to just get inspired by the existing projects and see what kind of documents they have in their root folder)
- Mention the CII best practices checks, it is super easy to go through the list of items it gives you as lacking on the project and it goes a long way (to me at least) if you are compliant.
- "Pro" tip: Github Actions are awesome, even with the recent outages, I highly recommend to every maintainer setting it up, it takes 5 minutes as long as your project has a build script that works. I'm also happy to volunteer to field questions about this if someone has any about the syntax or anything else. And of course, the other pro tip about copying from other projects stands here as well.
- Would also include some generic OSS project maintainer guides links that aren't specific to HL but would apply, nevertheless.