The project currently does not use Conventional Commits or any specific conventions. Work is branched and merged from main as the main trunk.
For the internal devrel guide, see the Solas documentation
Clone the repository if it has not been done already. This only has to be done once to set up the project
git clone [email protected]:algorandfoundation/devportal.git
Update the latest changes from the remote repository
git fetch
Please use the following convention when naming branches for clarity:
{feat/fix/chore/change}/topicgroup-section-page
For example:
git checkout feat/algokit-utils-client
Provide a descriptive commit message that outlines the changes. Changes must be done via a Pull Request (PR).
Ensure the following acceptance criteria are met before submitting a PR:
- Ensure there are no typos in the content
- Ensure
pnpm run lint
passes - Ensure
pnpm run build
passes
Currently only staging
is being used to produce a GithubPage.
This may change to preview based deployments with a provider like Cloudflare