✨ Contribution Opportunity: Review the Optimism Monorepo contributing process

[smartcontracts]

What is a Contribution Opportunity?

A Contribution Opportunity is a concrete task that you can work on to contribute to the Optimism Collective.

---

Summary

The Optimism Monorepo is one of the primary places where work happens on the OP Stack, the open source software stack that powers the Optimism Collective. A smooth contribution process is important to getting new contributors into the Monorepo and making sure that they'll keep coming back.

Taking on this task would involve the following:

• Keep track of your experience with a detailed document
• Read through the Optimism Monorepo README and note any issues or missing information in the README
• Using the README, find the CONTRIBUTING document
• Using the CONTRIBUTING document, set up the Optimism Monorepo locally
• Build the components in the Optimism Monorepo
• Run the tests for the Optimism Monorepo
• Note any issues that you have during any of the above steps in your detailed document
• Publish the document by leaving a link as a comment on this issue

Impact

The Optimism Monorepo is a key location for ecosystem contributions. It's important to make sure that the contributing process is as smooth as possible. Any issues within this process should be caught and smoothed out so that potential contributors aren't stuck before they're able to make their first PR.

[Razga]

Hey, I would love to take this one!

[twopats]

Hey there! Here's a link to my review, hope it's of some value ^^

https://github.com/twopats/review-op-contribution-flow/blob/main/review.md

[twilwa]

Hey, I have a review to contribute that I'm working on -- but I had several steps that had different outputs/errors -- I've resolved most of them now, but whichever file makes it into the monorepo as a review should probably include a few extra clarifications and troubleshooting steps in case someone trips over the same things I did. Mind if I fork your review @twopats , then we can push the whole thing as a complete picture that covers possible pitfalls?

[twopats]

@twilwa invited you 👍

[arnavbee]

hey, is this issue still available to work on?