Skip to content

docs: add PR info to contributing doc #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2020
Merged

docs: add PR info to contributing doc #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
640d70a
update: contributing with info on PRs
Vafilor Jun 2, 2020
dbef45c
update: cleaned up wording around /kind label and removed setting the…
Vafilor Jun 2, 2020
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
24 changes: 24 additions & 0 deletions docs/getting-started/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,30 @@ We welcome all contributions and follow these highlights from [Google developer

Our documentation site is built on [Docusaurus](https://v2.docusaurus.io/).

## Commits

All commits should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) as closely as possible.

## Pull Requests

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

An example is:

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

* 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