Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions docs/getting-started/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,43 @@ All commits should follow [Conventional Commits](https://www.conventionalcommits

When making a pull request,

* Prefix the name with
* **fix** - fixing something
* **feature** - adding a feature
* **clean** - cleaning up code
* **chore** - something mundane like updating a version number
* **docs** - updating documents
* **tests** - adding tests
1. Prefix the name with the type of commit (fix, feature, docs, etc)
2. Add a /kind label in the description (enhancement, bug, etc)


### Prefix the name with the type

The types are

* **fix** - fixing something
* **feature** - adding a feature
* **clean** - cleaning up code
* **chore** - something mundane like updating a version number
* **docs** - updating documents
* **tests** - adding tests

An example is:

```
fix: issue where workspace page crashed upon three refreshes.
fix: issue where workspace page crashed upon three refreshes
```

### Add a /kind label

A /kind label helps further identify what the pull request is for

The types are

* bug
* enhancement
* docs

An example is:

```
/kind enhancement
```

* Add the a /kind label in your PR description (enhancement, bug, etc)

## Project repositories
Onepanel consists of the following repositories. See `CONTRIBUTING.md` file in each repository for more information.
Expand Down