├── .github ├── ISSUE_TEMPLATE │ ├── add_scroll_to.yaml │ └── propose_new_skunkworks.yaml ├── pull_request_template.md └── workflows │ └── triage.yml ├── .gitignore ├── CONTRIBUTING.md ├── README.md ├── assets └── banner.png └── contributions.json /.github/ISSUE_TEMPLATE/add_scroll_to.yaml: -------------------------------------------------------------------------------- 1 | name: Add Scroll to some tool or library 2 | description: This brings Scroll compatibility into an existing library or project 3 | title: Add Scroll to 4 | labels: ["integration"] 5 | body: 6 | - type: input 7 | id: integration_name 8 | attributes: 9 | label: "Name of the project" 10 | placeholder: "Example: wagmi" 11 | validations: 12 | required: true 13 | - type: dropdown 14 | id: integration_type 15 | attributes: 16 | label: "Project type" 17 | options: 18 | - Library 19 | - Tool 20 | validations: 21 | required: true 22 | - type: input 23 | id: integration_site_link 24 | attributes: 25 | label: "Site of the project" 26 | placeholder: "https://wagmi.sh/" 27 | validations: 28 | required: false 29 | - type: input 30 | id: integration_github_link 31 | attributes: 32 | label: "Github repository of the project" 33 | placeholder: "https://github.com/wagmi-dev/wagmi" 34 | validations: 35 | required: true 36 | - type: dropdown 37 | id: integration_network 38 | attributes: 39 | label: "Networks" 40 | description: "On which networks should this be supported? (You can pick multiple options)" 41 | multiple: true 42 | options: 43 | - Scroll Testnet - Sepolia 44 | - Scroll Mainnet 45 | validations: 46 | required: true 47 | - type: textarea 48 | id: integration_description 49 | attributes: 50 | label: "Additional context" 51 | description: "Describe any context, screenshot or specification of changes here" 52 | validations: 53 | required: false -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/propose_new_skunkworks.yaml: -------------------------------------------------------------------------------- 1 | name: "Propose new Skunkworks project" 2 | description: "Skunkworks are Innovative ideas that inspire developers, explore new use cases, and illustrate best practices on Scroll" 3 | title: "Skunkworks Project Suggestion: " 4 | labels: ["skunkworks :skunk:"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: " 9 | ## What is Skunkworks about? 10 | 11 | General idea of Skunkworks as per [wikipedia](https://en.wikipedia.org/wiki/Skunk_Works) is: 12 | 13 | > The designation 'skunk works' or 'skunkworks' is widely used in business, engineering, and technical fields to describe **a group within an organization given a high degree of autonomy and unhampered by bureaucracy, with the task of working on advanced or secret projects**\n 14 | 15 | **But what is it for us?** 16 | 17 | Skunkworks are Innovative ideas that inspire developers, explore new use cases, and illustrate best practices on Scroll. 18 | 19 | Every time you feel like something would be cool to exist related to Scroll, ZK, Developer Tooling etc. post it here. 20 | If you ever feel like it’s too crazy, remember, zkEVM was crazy idea just a few years ago 🙂 21 | 22 | >There is no great genius without some touch of madness. 23 | " 24 | - type: input 25 | id: skunkworks_name 26 | attributes: 27 | label: "Name of the project" 28 | placeholder: "Example: Metamask Snap for Scroll" 29 | validations: 30 | required: true 31 | - type: textarea 32 | id: skunkworks_abstract 33 | attributes: 34 | label: "Project abstract" 35 | description: "Abstract description of the Skunkworks project you're proposing" 36 | validations: 37 | required: true 38 | - type: textarea 39 | id: skunkworks_specification 40 | attributes: 41 | label: "Specification" 42 | description: "Specification, pictures and any other resources that are useful for describing this project" 43 | validations: 44 | required: true -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # Checklist ✅ 2 | - [ ] I've read [CONTRIBUTIONS.md](https://github.com/scroll-tech/contribute-to-scroll/blob/main/CONTRIBUTIONS.md) document 3 | - [ ] I've filled the `contributions.json` file 4 | 5 | # Issues this PR Resolves 🚀 6 | - Link to the Issue: 7 | - Link to the resolving PR on 3rd party repo: 8 | 9 | # Contributor social handles (Github / Twitter / Telegram) 🎙️ 10 | 1. Example Contributor 11 | - Github: [scroll-tech](https://github.com/scroll-tech) 12 | - Twitter: [Scroll_ZKP](https://twitter.com/Scroll_ZKP) 13 | 2. Example Anonymous Contributor 14 | - Github: anon 15 | 16 | # Contribution Description 📝 17 | _Describe your work in more details here_ 18 | 19 | # Additional Resources 🔗 20 | _Add any additional links you feel like will help with the review here (Contract Address, Deployer Address, Links to the code etc.)_ 21 | -------------------------------------------------------------------------------- /.github/workflows/triage.yml: -------------------------------------------------------------------------------- 1 | name: Label issues 2 | on: 3 | issues: 4 | types: 5 | - reopened 6 | - opened 7 | jobs: 8 | label_issues: 9 | runs-on: ubuntu-latest 10 | permissions: 11 | issues: write 12 | steps: 13 | - uses: actions/github-script@v6 14 | with: 15 | script: | 16 | github.rest.issues.addLabels({ 17 | issue_number: context.issue.number, 18 | owner: context.repo.owner, 19 | repo: context.repo.repo, 20 | labels: ["triage-new-issue"] 21 | }) 22 | 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribute to Scroll Guidelines 2 | 3 | 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. 4 | 5 | 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. 6 | 7 | ## Getting Started 8 | 9 | ### Finding an Issue 10 | 11 | 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! 12 | 13 | ### Creating an Issue 14 | 15 | 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. 16 | 17 | #### How to create an issue? 18 | To create an issue, you have several options: 19 | - Use predefined issue templates found [here](https://github.com/scroll-tech/contribute-to-scroll/issues/new/choose). With these you can: 20 | - **"Add Scroll to some tool or library"** - _Integrate Scroll into your favourite project_ 21 | - **"Propose new Skunkworks project"** - _Have some innovative idea you want built on top of Scroll? Propose it here!_ 22 | - [Open a blank issue](https://github.com/scroll-tech/contribute-to-scroll/issues/new) if none of the previous options fit your proposal 23 | 24 | And that's it! You've started your contribution to Scroll journey 📜 🚀 25 | 26 | ### Making a PR 27 | 28 | 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. 29 | 30 | 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. 31 | 32 | #### Making a PR to this Repo 33 | 34 | 1. Fork the `contribute-to-scroll` repo. 35 | 2. Add your contribution, showing the Issue it closes (or contributes to), along with the link to the PR raised in another repo. 36 | 3. Describe your work and fill out the template. 37 | 4. Add a new entry to the `contributions.json` file by following the same format as the other projects listed. 38 | 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. 39 | 40 | ### Collecting your GitPOAP 41 | 42 | Coming Soon. 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Contribute to Scroll](./assets/banner.png) 2 | 3 | [![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/scroll-tech/contribute-to-scroll/badge)](https://www.gitpoap.io/gp/1057) 4 | [![Twitter Follow](https://img.shields.io/twitter/follow/Scroll_ZKP?style=social)](https://twitter.com/Scroll_ZKP) 5 | [![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/scroll) 6 | 7 | This repository guides developers wanting to contribute to Scroll. You can start contributing today, if you need ideas on getting started check out the [issues](https://github.com/scroll-tech/contribute/issues) tab. 8 | 9 | ## How to Contribute 10 | 11 | Thanks for your interest in contributing to Scroll. Check out the [CONTRIBUTING](https://github.com/scroll-tech/contribute/blob/main/CONTRIBUTING.md) page for a guide on how to contribute. 12 | 13 | ## Contributions 14 | 15 | ### Integrations 16 | 17 | Scroll has been integrated on the following projects: 18 | 19 | - [ethereum-lists/chains](https://github.com/ethereum-lists/chains/) 20 | 21 | ## About Scroll 22 | 23 | Scroll is an open source zkEVM Layer 2 that helps scaling Ethereum. Scroll is bytecode equivalent with the EVM, which makes possible native compatibility for existing Ethereum applications. Learn more about Scroll in [the docs](https://docs.scroll.io/). 24 | 25 | ## Contributors 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /assets/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scroll-tech/contribute-to-scroll/90980bd3baaac3dc5a64442a8085819e8fc88ed2/assets/banner.png -------------------------------------------------------------------------------- /contributions.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "contribution-title": "Add Scroll Sepolia to Chainlist", 4 | "project-repo": "https://github.com/ethereum-lists/chains/", 5 | "contributors": ["dghelm"] 6 | }, 7 | { 8 | "contribution-title": "Add Scroll to ethereum-multicall", 9 | "project-repo": "https://github.com/joshstevens19/ethereum-multicall/", 10 | "contributors": ["omahs"] 11 | }, 12 | { 13 | "contribution-title": "A MetaMask Snap for Calculating L1 Fees for Scroll Transactions", 14 | "project-repo": "https://github.com/0x4r45h/L2Insights", 15 | "contributors": ["0x4r45h"] 16 | }, 17 | { 18 | "contribution-title": "Add multicall3 address for Scroll Sepolia to wagmi", 19 | "project-repo": "https://github.com/wagmi-dev/viem", 20 | "contributors": ["RexCloud"] 21 | } 22 | ] 23 | --------------------------------------------------------------------------------