First off, thank you for taking the time to contribute to Open Web ❤️
It's important to note early on that these projects are written with TypeScript. If you're unfamiliar with it or any strongly typed languages such as Java then this may be a slight roadblock. However, there's never a truly perfect time to start learning it, so ... why not today!
Don't be discouraged, because you likely will get by learning TypeScript on-the-fly as you view some of the component examples within the codebase. It's easy getting started—the code is very readable!
This project uses Stacks as its framework/engine. Under the hood, it is powered by Vue & Vite to build Vue components, Web Components, and "composable functions".
An understanding of the library architecture and design will help if you're looking to contribute long-term, or you are working on a big PR. Browse the source and read our documentation to get a better idea on how it is structured. Feel free to ask any question (Twitter, Discord, or GitHub Discussions), we would love to elaborate.
Please view the README and the instructions below on how to install the project locally.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.
Head over to the repository on GitHub and click the Fork button in the top right corner. After the project has been forked, run the following commands in your terminal:
# Replace {github-username} with your GitHub username.
git clone https://github.com/{github-username}/stacks --depth=1
cd stacks
# Create a branch for your PR, replace {issue-no} with the GitHub issue number.
git checkout -b issue-{issue-no}Now it'll help if we keep our main branch pointing at the original repository and make
pull requests from the forked branch.
# Add the original repository as a "remote" called "upstream".
git remote add upstream git@github.com:ow3org/stacks.git
# Fetch the git information from the remote.
git fetch upstream
# Set your local main branch to use the upstream main branch whenever you run `git pull`.
git branch --set-upstream-to=upstream/main main
# Run this when we want to update our version of main.
git pullThe following list is of some of the most common ways to interact with the Stacks API. Meet Artisan:
pnpm artisan install # installs all dependencies
pnpm artisan dev # starts one of the dev servers (components, functions, pages, or docs)
pnpm artisan build # follow CLI prompts to select which library (or server) to build
pnpm artisan commit # follow CLI prompts for committing changes
pnpm artisan release # creates the releases for the stack & consequently, publishes them to npm
pnpm artisan make:component HelloWorld # bootstraps a HelloWorld component
pnpm artisan make:function HelloWorld # bootstraps a HelloWorld function
pnpm artisan make:page hello-world # bootstraps a HelloWorld page (https://127.0.0.1/hello-world)
pnpm artisan helpView the complete Artisan Toolkit
pnpm artisan install # or `pnpm i`
pnpm artisan fresh # fresh reinstall of all deps
pnpm artisan dev # starts one of the dev servers (components, functions, or docs)
pnpm artisan dev:components # starts local playground dev server
pnpm artisan dev:docs # starts local docs dev server
pnpm artisan make:component HelloWorld
pnpm artisan make:function hello-world
pnpm artisan stub # stubs all the libraries
pnpm artisan stub:components # stubs the component library
pnpm artisan stub:functions # stubs the function library
pnpm artisan lint # runs linter
pnpm artisan lint:fix # runs linter and fixes issues
pnpm artisan commit # follow CLI prompts for committing staged changes
pnpm artisan release # creates the releases for the stack & triggers the Release Action (workflow)
pnpm artisan changelog # generates CHANGELOG.md
# building for production (e.g. npm)
pnpm artisan build # select a specific build (follow CLI prompts)
pnpm artisan build:components # builds component libraries
pnpm artisan build:functions # builds function library
pnpm artisan build:web-components # builds framework agnostic Web Component library (i.e. Custom Elements)
# when building for Vercel, Netlify, and more
pnpm artisan deploy:docs
# creates a server to be deployed into any VPS
pnpm artisan server:functions # wip
pnpm artisan example # select the example to run (follow CLI prompts)
# test your stack
pnpm artisan test # runs test suite
pnpm artisan test:unit # runs unit tests
pnpm artisan test:e2e # runs e2e tests
pnpm artisan test:coverage # runs test coverage
pnpm artisan test:types # runs typecheckEach of our components come with test cases. Feel free to check them out within the ./tests root folder. When adding or or updating functionality, please ensure it is covered through our tests cases. Ensure so by running pnpm test.
This project uses semantic commit messages to automate package releases. We automated the commit process for you, and simply run pnpm run commit in your terminal and follow the instructions.
For example,
# Add all changes to staging to be committed.
git add .
# Commit changes.
pnpm run commit
# Push changes up to GitHub.
git pushWhen you're all done, head over to the repository, and click the big green
Compare & Pull Request button that should appear after you've pushed changes to your fork.
Don't expect your PR to be accepted immediately or even accepted at all. Give the community time to vet it and see if it should be merged. Please don't be disheartened if it's not accepted. Your contribution is appreciated more than you can imagine, and even a failed PR can teach us a lot ❤️