If you have direnv and nix installed, all you have to do is cd into the directory where you clones the repository!
Otherwise, look at shell.nix and nix/dev-dependencies.nix for development dependencies and any setup you might want to do.
Note that you don't need a the linter/formatter if you don't need to edit a file for which is used.
This project uses docz for documentation generation, but this is also where you can try out the components in some pre-made environments while developing.
This project was developed using pnpm.
There have been cases in the past where npm wouldn't even manage to install
all dependencies correctly.
If you run into any dependency related issues, using pnpm is the first thing you should try.
If you're adding a feature or making any other kind of improvement, name your branch feature/<your-feature>.
If you're fixing something, name you're branch fix/<the-thing-youre-going-to-fix>.
If merge conflicts are detected on your PR, rebase.
If you derped and need to fix something from an older commit, I'd rather have you revise and force push then adding a tiny fixup commit. Keep the history clean :).
I went a little overboard on the development environment for this package, but the only thing that won't work out of the box is validation of the CircleCI config pre-commit. If you've edited it, you'll need their CLI installed on your system.
npm login- Create a
.npmrcfor publishing to GitHub and enter your token: //npm.pkg.github.com/:_authToken= registry=https://npm.pkg.github.com/cdfa - Encrypt it with
gpg:gpg -se .npmrc. - Now you can remove the file
rm .npmrc. It will be decrypted again when publishing.
git flow release start <version>npm version <version>- Update Changelog
npm run publish-allgit flow release finishgit push origin --tags