diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f1631df..eaed0924 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ If you have found an issue with `@txnlab/use-wallet`, please follow these steps: - Describe the exact steps which reproduce the problem in as much detail as possible. - To help triage and fix the issue quickly, please provide a minimal reproducible example. -To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/). +To create a shareable code example, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/). Feel free to fork any of our CodeSandbox examples to reproduce your issue: @@ -95,13 +95,11 @@ If you want to contribute to `@txnlab/use-wallet`, please follow these steps to `TxnLab/use-wallet` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). -We have very precise rules over how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. +We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. ### Commit Message Format -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special -format that includes a **type**, a **scope** and a **subject**: +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` (): @@ -113,8 +111,7 @@ format that includes a **type**, a **scope** and a **subject**: The **header** is mandatory and the **scope** of the header is optional. -Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier -to read on GitHub as well as in various git tools. +Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools. ### Type @@ -123,24 +120,21 @@ Must be one of the following: - **feat**: A new feature - **fix**: A bug fix - **docs**: Documentation only changes -- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing - semi-colons, etc) +- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) - **refactor**: A code change that neither fixes a bug nor adds a feature - **perf**: A code change that improves performance - **test**: Adding missing or correcting existing tests -- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation - generation +- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation ### Scope -The scope could be anything specifying place of the commit change. For example `core`, `react`, -`vue`, and `solid` refer to the core library and adapters, while `defly`, `pera`, `lute`, etc. refer to individual wallet clients. +The scope could be anything specifying the place of the commit change. For example `core`, `react`, `vue`, and `solid` refer to the core library and adapters, while `defly`, `pera`, `lute`, etc. refer to individual wallet clients. You can use `*` when the change affects more than a single scope. ### Subject -The subject contains succinct description of the change: +The subject contains a succinct description of the change: - use the imperative, present tense: "change" not "changed" nor "changes" - don't capitalize first letter @@ -148,23 +142,17 @@ The subject contains succinct description of the change: ### Body -Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". -The body should include the motivation for the change and contrast this with previous behavior. +Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior. ### Footer -The footer should contain any information about **Breaking Changes** and is also the place to -[reference GitHub issues that this commit closes][closing-issues]. +The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit closes. -**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. -The rest of the commit message is then used for this. +**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. ### Revert -If the commit reverts a previous commit, it should begin with `revert: `, followed by the header -of the reverted commit. -In the body it should say: `This reverts commit .`, where the hash is the SHA of the commit -being reverted. +If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit .`, where the hash is the SHA of the commit being reverted. ## Pull Requests