We're beyond grateful for your interest in contributing to the Spin project. We're always looking for ways to improve the project and we're excited to see what you have to offer.
- Please be intentional and clear in your proposal
- If you're looking to add a new feature, it may be a good idea to open an issue first to discuss the feature
All docs are located under
docs/. In there is a "Nuxt Content" site. Read
docs/README.md for more information on how to run the docs locally.
If you'd like to install a copy for development, clone your fork and add this to your shell profile:
Add an alias to your shell profile
You you point
spin on to your project, you'll be able to easily test changes before submitting a pull request.
Other than having a working Docker Desktop or Docker Engine installation -- the only other dependency is running Bash v3 or higher. This means there literally are not any other dependencies to install. 🥳
The install script allows you to install a specific branch of Spin. This is useful if you want to test a new feature or bug fix before it's released.
Install a test version of Spin
BRANCH="release/2.0" bash -c "$(curl -fsSL -H "Cache-Control: no-cache" https://raw.githubusercontent.com/serversideup/spin/main/tools/install.sh)"
Testing a local installation script
bash -c "$(cat /path/to/the-project/spin/tools/install.sh)"
bin/spin- This is the main entry point for the
spincommand. This file is responsible for parsing the arguments and calling the appropriate function.
lib/functions.sh- This file contains all of the functions that are called by
lib/actions/- This directory contains all of the actions that are called by
bin/spin. Each action is a file that contains a function with the same name as the file. For example,
lib/actions/init.shcontains a function called
init. This function is called by
initaction is called.