- Initialize repository (typically via
git init
) - Ensure default branch name is
main
(notmaster
) - Install dependencies (typically via
npm install
) - Acknowledge pre-configured precommit git hooks, they validate changes to be committed against preconfigured lint rules and expected prettier style.
If for some reason in context of this project you don't find it helpful, ensure to remove allhusky
andlint-stage
related configuration. - Acknowledge pre-configured semi-automation of a release process. For that to work as expected, project is expected to to follow semantic commit messages.
See proposed Commit Message Guidelines.
If for some reason in context of this project you don't find it helpful, ensure to remove allcommitlint
andstandard-version
related configuration, and cleanup.travis.yml
. - Fill all occurences of CHANGEME found in any files across a project with expected counterparts. While doing that also remove this section.
- (Needed for automatic tagging of new releases and sending release notes) Configure serverless-ci auth token (just
public_repo
scope is needed) intoUSER_GITHUB_TOKEN
GitHub secret for CI/CD - (Needed for npm publications) Configure serverless-main auth token into
NPM_TOKEN
GitHub secret for CI/CD - Commit created changes, ideally by combining them into initial commit by pursuing following steps:
git stash
git rebase -i --root
Change here 'pick' to 'edit' on first commitgit stash pop
git add -A .
git commit --amend '-S'
Confirm on initial commit message.
(note: this one doesn't necessarily need to confirm to commitlint. To make it distinct you may use emotikon as💥
).git rebase --continue
git push -f
- Ideally all further updates should go through CI validated and reviewed PR's