-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update some docs all around (#170)
- Loading branch information
Showing
12 changed files
with
33 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ | |
|
||
We use [conventionalcommits](https://conventionalcommits.org) to format our commit messages. This leads to **more | ||
readable messages** that are easy to follow when looking through the **project history**. But also, | ||
we use the git commit messages to generate the [Sentry Testkit release notes](https://github.com/wix/sentry-testkit/releases). | ||
we use the git commit messages to generate the [Sentry Testkit release notes](https://github.com/zivl/sentry-testkit/releases). | ||
|
||
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**: | ||
|
@@ -20,23 +20,23 @@ format that includes a **type**, a **scope** and a **subject**: | |
More info about message format and list of types could be found [here](https://conventionalcommits.org) | ||
|
||
## Local Setup | ||
1. `git clone [email protected]:wix/sentry-testkit.git` | ||
1. `git clone [email protected]:zivl/sentry-testkit.git` | ||
2. `npm install` | ||
|
||
## Writing Code | ||
* Make sure to write functions with minimal side effects. | ||
* We always prefer `const` on `let`. | ||
* Make up clear and readable variable names and function names. | ||
* Update documentation in case you add/modify/remove any kind of behaviour. | ||
* Test any code that you push in. | ||
* Test any code that you push in. | ||
|
||
## Git Stuff | ||
* Make sure you're rebased with `master` branch. Especially if you're working on a long feature. | ||
* Your PRs will be merged after passing all relevant conditions (build, testing... etc.). | ||
|
||
## Release | ||
|
||
We use [standard-version](https://github.com/conventional-changelog/standard-version) to prepare the [CHANGELOG.md](./CHANGELOG.md) file and git tags (to have correct [release notes](https://github.com/wix/sentry-testkit/releases)). | ||
We use [standard-version](https://github.com/conventional-changelog/standard-version) to prepare the [CHANGELOG.md](./CHANGELOG.md) file and git tags (to have correct [release notes](https://github.com/zivl/sentry-testkit/releases)). | ||
|
||
Release process: | ||
* merge all related PRs to master; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters