Contribute To SBS

We love open-source! We value and appreciate all the feedback and help we can get so please don't be shy!

Open An Issue

Are you stuck, confused, or just want to give us some feedback? Feel free to open issues on the most relevnat public repository belonging to the Super BlockChain Scaffolder organization.

Add A New Starter

The "master list" of starters lives its own special repository, and the data describing each starter is held within the file named sbs-master-list.yaml file.

Step 1) Stick A Fork In It

Since you don't have permissions to push directly to this repository, you should _fork_ it and make the changes to your fork.

Step 2) Add Your Starter

Append a new block the bottom document with information about your starter.

- name: 'Foundry Starter Kit'
    repo-url: 'https://github.com/your_github_account/starter_project_name'
    live-url: 'url for a live site for your project (or same as github repo url)'
    description: 'A description of your project.'
    maintainers:
        - text: 'A human readable name'
        - link: 'An email address or link to social media profile'
    tags:
    - 'Example Tag'
    - 'Another Example Tag'

Step 3) Open A Pull Request

Once you've commited your changes to the sbs-master-list.yaml file in your fork you'll want to open a pull request across forks in the sbs-master-list repo.

When you open a pull request some tests will automatically be run to verify things like that the master list is proper yaml, that all starter objects have valid keys, that the provided git repo url exists, etc. Note that your pull request will NOT be accepted if it has any failing tests.

When a member of the sbs core team approves your PR then your starter should be immediately available to be scaffolded! Users of the sbs cli do NOT need to update their cli tool in order to see updated packages.

Step 4) Keep Your Project Repo Updated

The master list stores more or less just a pointer to your project's git repository. This means that when you make updates to your project's repository you do not need to do anything to let the sbs cli know that there is a newer version available.

The sbs cli will always scaffold the files and folders of the repository branch named main

Your users will appreciate if you keep the starter in a stable state that compiles cleanly and has up-to-date dependencies! 😉

Contribute To This Website

This website is a completely open-source React/Vite project with source code hosted in the sbs-website repository.

Check out the sbs-website list of things todo for ideas on things you could work on, and don't be afraid to open an issue for the sbs-website if you have sbs-cli ideas and/or feedback on our website!

Contribute To The CLI Tool Source Code

The sbs cli tool is an open-source project built in Rust which lives in the sbs-cli repository.

Check out the sbs-cli list of things todo for ideas on things you could work on, and don't be afraid to open an issue for the sbs-cli if you have ideas and/or feedback on our cli tool!

Contribute To The SBS Master List Project

In the steps above we covered how to add a new starter by adding the information about the new starter to the "sbs-master-list.yaml" file located in the sbs-master-list repository.

Check out the sbs-master-list things todo for ideas on things you could work on, and don't be afraid to open an issue for the sbs-master-list if you have ideas and/or feedback on how the sbs master list works!

Spread The Word

One last way we'd like to ask you to contribute to our success is by telling your friends about this cool thing we've made.

Thanks for taking the time to check us out! 🙏

History of SBS

The Super Blockchain Scaffolder was born by two software engineers, Jim Lynch and Prananv Soni, who came together and started this project during the Chainlink Spring 2023 hackathon.

The Super Blockchain Scaffolder is meant to be a tool for blockchain developers, creators, authors, and everyone in between! Whether you are an experienced blockchain architect looking to kick off new projects quickly or a complete beginner wondering where to get started, sbs-cli is the tool for you!