Contribution Guide PWA
1: Create an issue:
Every change to the code and every pull request must be assigned to an issue. The issue ID created is required for the following steps.
3: Install dependencies:
4: Setup hubble for module development:
- Create .env files in playground and
npm run dev:prepareto generate type stubs.
npm run devto start playground in development mode.
5: Test production build:
npm run prepackto bundle module source code
npm run dev:buildto build playground in production mode
node playground/.output/server/index.mjsto start node server
6: Tracking the original repository as a remote fork:
This is especially important to keep the fork up to date to the original repository (upstream).
git remote add --track main upstream https://github.com/hubblecommerce/hubble-frontend-pwa.git git fetch upstream
7: Create a new branch for the issue based on the upstream main branch:
git checkout -b issue#<NUM> upstream/main
8: Push changes to the code to the fork repository (specify issue ID):
git add . git commit -m "issue#<NUM> my detailed commit message" git push -u origin issue#<NUM>
9: Create a Pull Request:
Go to Pull Requests. You should see an automatic suggestion from Github to make a new pull request from the created branch