When contributing to Kubb, whether on GitHub or in other community spaces:
- Be respectful, civil, and open-minded.
- Before opening a new pull request, try searching through the issue tracker for known issues or fixes.
- If you want to make code changes based on your personal opinion(s), make sure you open an issue first describing the changes you want to make, and open a pull request only when your suggestions get approved by maintainers.
In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by opening an issue describing the problem you would like to solve.
Some commands will assume you have the GitHub CLI installed, if you haven't, consider installing it, but you can always use the Web UI if you prefer that instead.
In order to contribute to this project, you will need to fork the repository:
gh repo fork kubb-labs/kubbthen, clone it to your local machine:
gh repo clone <your-github-name>/kubbWhen making commits, make sure to follow the conventional commit guidelines, i.e. prepending the message with feat:, fix:, chore:, docs:, etc... You can use git status to double check which files have not yet been staged for commit:
git add <file> && git commit -m "feat/fix/chore/docs: commit message"Next to conventional commit we also use changesets. Run the following command and follow the steps in the CLI. You will be prompted to select the changed packages, select if the changes are major/minor/patch and a message that you want to add to generated changelog.
pnpm run changeset
npx changesetWhen all that's done, it's time to file a pull request to upstream:
NOTE: All pull requests should target the main branch.
This documented was inspired by the contributing guidelines for create-t3-app.