multiformats / multiformats/js-multiformats
Establish clear ownership of js-multiformats
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 268
- Forks
- 57
- PR merge metrics
- No merged PRs in 30d
Description
Background
The lack of unified consensus of https://github.com/multiformats/js-multiformats/issues/249 highlighted that there is a lack of clarity on the ownership of this repo. CODEOWNERS isn't defined, and there isn't an understanding of how owners should handle disagreements. Some of the main contributors of this repo over the last 12 months are individuals who do this on the side of other team work they have (@rvagg and @Gozala - thank you!). Others help maintain here as part of their full-time maintenance and development of libraries that consume this repo (e.g., js-libp2p, Helia).
Done criteria
- Create CODEOWNERs
- Document what is expected of a CODEOWNER
- Document where triage and synchronous decisions for this repo are handled
Proposal
- CODEOWNERs for now should be existing maintainers who have stayed involved with the project (i.e., @rvagg, @Gozala) or consuming projects that have stayed involved in the project (js-libp2p, Helia). (It's fine if any of these individuals/groups want to back out.). Lets handle this in https://github.com/multiformats/github-mgmt/pull/83
- In the absence of another venue currently and the general change happening to PL EngRes teams as they "nucleate" out from PL, I'd like to propose that we house triage and synchronous conversations as part of js-libp2p triage since it is a multiple organization venue that meets weekly. (We know this time is not conducive for everyone, so we are also happy to find an alternative venue.)
- Concerning the expectations of codeowners, I don't think we need to be too prescriptive here, but at the minimum, I think they should engage on open issues and PRs when pinged within a week. Ideally they would also proactively engage on issues and PRs and participate in triage.
### Proposed actions
- [ ] Create CODEOWNERs: https://github.com/multiformats/github-mgmt/pull/83
- [ ] Update README with triage info: https://github.com/multiformats/js-multiformats/pull/274
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing github-mgmt PR #83 and js-multiformats PR #274, then inspect the repository's CODEOWNERS setup and README. Done means ownership is established, CODEOWNER expectations are documented, and the triage and synchronous decision venue is recorded; the issue's proposed actions are already being handled elsewhere.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100