Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.41 KB
Raw

Contribution Guide

This section aims to familiarise developers with Polkadot UI for the purpose of contributing to the project.

Reach out to [email protected] for clarification of any content within this document.

Submitting Pull Requests

This project follows the Conventional Commits specification. Pull requests are merged and squashed, with the pull request title being used as the commit message. Commit messages should adhere to the following structure:

<type>(<scope>): <summary>

Some example PR titles:

  • feat: implement help overlay
  • feat(auth): implement login API
  • fix(button): resolve issue with button alignment
  • docs(readme): add installation section
  • chore(tests): refactor user tests

The (scope) could be anything specifying the place of the commit change. For example, api, app, cli, etc.

If you would like to know more about the Conventional Commits specification, please visit the Conventional Commits website.

Releases

Release Please is used for automating staking dashboard's changelog and release generation.

Release Please is a GitHub action maintained by Google that automates CHANGELOG generation, the creation of GitHub releases, and version bumps. [Gtihub docs, Action]