mirror of
https://github.com/qlik-oss/nebula.js.git
synced 2025-12-19 17:58:43 -05:00
chore: format commits (#304)
This commit is contained in:
43
.github/CONTRIBUTING.md
vendored
43
.github/CONTRIBUTING.md
vendored
@@ -51,9 +51,10 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
|
||||
- `yarn run lint` checks code style
|
||||
- `yarn run test` runs all tests
|
||||
|
||||
### Cutting a release
|
||||
### Cutting a release
|
||||
|
||||
**Prerelase**
|
||||
|
||||
```sh
|
||||
npx lerna version --no-git-tag-version --no-push --no-conventional-commits --preid alpha --exact
|
||||
```
|
||||
@@ -65,40 +66,40 @@ Generally, development should be done directly towards the `master` branch.
|
||||
### Branching
|
||||
|
||||
1. Fork and clone the repository
|
||||
```sh
|
||||
git clone git@github.com:YOUR-USERNAME/nebula.js.git
|
||||
```
|
||||
|
||||
```sh
|
||||
git clone git@github.com:YOUR-USERNAME/nebula.js.git
|
||||
```
|
||||
|
||||
1. Create a branch in the fork
|
||||
|
||||
The branch should be based on the `master` branch in the master repository.
|
||||
|
||||
```sh
|
||||
git checkout -b my-feature-or-bugfix master
|
||||
```
|
||||
The branch should be based on the `master` branch in the master repository.
|
||||
|
||||
```sh
|
||||
git checkout -b my-feature-or-bugfix master
|
||||
```
|
||||
|
||||
1. Commit changes on your branch
|
||||
|
||||
Commit changes to your branch, following the commit message format.
|
||||
Commit changes to your branch, following the commit message format.
|
||||
|
||||
```sh
|
||||
git commit -m "fix: properly formatted SET statements."
|
||||
```
|
||||
```sh
|
||||
git commit -m "fix: properly formatted SET statements."
|
||||
```
|
||||
|
||||
1. Push the changes to your fork
|
||||
|
||||
```sh
|
||||
git push -u myfork my-feature-or-bugfix
|
||||
```
|
||||
```sh
|
||||
git push -u myfork my-feature-or-bugfix
|
||||
```
|
||||
|
||||
1. Create a Pull Request
|
||||
|
||||
> Before creating a Pull Request, make sure to sign the [CLA](#cla)
|
||||
> Before creating a Pull Request, make sure to sign the [CLA](#cla)
|
||||
|
||||
In the Github UI of your fork, create a Pull Request to the `master` branch of the master repository.
|
||||
|
||||
If the branch has merge conflicts or has been outdated, please do a rebase against the `master` branch.
|
||||
In the Github UI of your fork, create a Pull Request to the `master` branch of the master repository.
|
||||
|
||||
If the branch has merge conflicts or has been outdated, please do a rebase against the `master` branch.
|
||||
|
||||
### <a name="commit"></a> Commit message guidelines
|
||||
|
||||
@@ -126,4 +127,4 @@ The `<scope>` of the commit is optional and can be omitted. When used though, it
|
||||
|
||||
## <a name="cla"></a> Signing the CLA
|
||||
|
||||
We need you to sign our Contributor License Agreement (CLA) before we can accept your Pull Request. Visit this link for more information: https://github.com/qlik-oss/open-source/blob/master/sign-cla.md.
|
||||
We need you to sign our Contributor License Agreement (CLA) before we can accept your Pull Request. Visit this link for more information: https://github.com/qlik-oss/open-source/blob/master/sign-cla.md.
|
||||
|
||||
Reference in New Issue
Block a user