👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to the Forgerock SDK and its packages, which are hosted in the ForgeRock organization on GitHub.
Fork the repo to your own github account. From there, you can add the ForgeRock repository as an upstream.
git remote add upstream git@github.com:ForgeRock/forgerock-javascript-sdk.git
- Please make all pull requests against
develop
branch. - Fill out the Pull Request template that appears when you open a PR.
- Please ensure
pnpm run lint
reports no issues. - Please ensure
pnpm run build
reports no issues. - Please ensure
pnpm run test
reports no failures. - Please ensure your PR passes all PR checks.
- When your PR is ready to merge please rebase your commit into 1 commit.
- Commits should be verified (meaning you cannot squash your commit on github).
- Please ensure your code is passing CI in order to get a review.
- Structure your commit messages similarly to the Conventional Commit Conventions.
<type>(<scope>): <short summary>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>