reth
reth copied to clipboard
paradigmxyz
Pre-open source checklist
A few things we need to sort out before open sourcing:
- [x] Code of conduct
- [x] Contributing guidelines
- [x] Issue and PR templates
- [ ] Good contributor docs
- [ ] A manual/book
- [x] Responsible disclosure (cc @gakonst I think this is something you are best suited to figure out?)
- [ ] Release flow
In terms of release workflow, we need to discuss what our direction is in three-ish areas: means of distribution, how often we release, and if we provide LTS.
On the first area, @gakonst expressed that we should have something like foundryup. I think generally this works OK for developer tooling, but I'm unsure if this will work for nodes, or if we should go a more traditional route and publish on popular package managers?
On the second area, I have no opinion, and on the third I don't have a strong opinion, but I do not have a lot of experience providing LTS and it might not make sense to do.
I think let's 0-1 everything we have from Foundry (foundryup equivalent + docs + book + nightly release), which should be easy. The foundryup workflow is very useful for debugging stuff and trying new releases, so it's still valuable.
Given that there's less fear of breaking changes wrt the node, I think going for Apt + Brew releases for launch makes sense.
No opinion on how often we release, we can evaluate later.
Let's setup changelogs etc. early on, and be VERY meticulous about our commits so that the auto-gen'ed changelogs are nice.
@onbjerg can you prio this? CoC, Guidelines, templates, contributing.md, responsible disclosure let's do [email protected]. i'm same page as you re: LTS. i don't think we need to commit to a release schedule yet, and want us to sprint towards open sourcing asap!
@onbjerg I spun up a contributing.md in #290 a la Foundry's contributing.md and there's a code of conduct section within the doc - i would assume that we don't need a separate code of conduct doc?
What more contributor docs do we want for OSS?. Anyone want to do a dep graph diagram to add to layout.md?
I think we can skip release flow as a OSS checklist item for now since we're not live yet.