Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 2.66 KB
Raw

Contribute to Scroll Guidelines

Thanks for helping to build the Scroll ecosystem! Contribution guidelines for this project are a bit odd, because the goal is to collect community contributions made in other repos — some in the scroll-tech organization, but many outside of it.

Please remember, you're representing Scroll's community when you engage with other code repos. Please follow their best practices and be considerate of any reviewer's time.

Getting Started

Finding an Issue

On our Issues page, you'll find a number of ways to contribute. Many are "Integrations" that help add Scroll and our testnets to ecosystem tooling, while others might be complex and imaginative projects!

Creating an Issue

Have an idea you'd like to see built? Want to see Scroll integrated in your favorite developer tooling? To the best of your ability, make an issue describing the project, linking to the appropriate repo and outlining what changes would need to be made. Someone from our team can then add additional tasks, context or even spec out or implement the code needed.

How to create an issue?

To create an issue, you have several options:

  • Use predefined issue templates found here. With these you can:
    • "Add Scroll to some tool or library" - Integrate Scroll into your favourite project
    • "Propose new Skunkworks project" - Have some innovative idea you want built on top of Scroll? Propose it here!
  • Open a blank issue if none of the previous options fit your proposal

And that's it! You've started your contribution to Scroll journey 📜 🚀

Making a PR

Please start by making a PR to any external repo first. You can then create a draft PR to this repo so that our team can help comment on and review any contributions to external projects.

Remember to review each external project's CONTRIBUTING.md file before making a PR. Scroll is community-first, and that means respecting the norms and requests of other code communities.

Making a PR to this Repo

  1. Fork the contribute-to-scroll repo.
  2. Add your contribution, showing the Issue it closes (or contributes to), along with the link to the PR raised in another repo.
  3. Describe your work and fill out the template.
  4. Add a new entry to the contributions.json file by following the same format as the other projects listed.
  5. Additional contributors will also need to make a commit to the PR (or a later PR). We suggest they do so by adding their name to the contributions.json file to receive acknowledgement.

Collecting your GitPOAP

Coming Soon.