Skip to content

Commit df2a8b2

Browse files
authored
updated contributing guide (#3129)
1 parent 54636b9 commit df2a8b2

File tree

1 file changed

+36
-10
lines changed

1 file changed

+36
-10
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ again.
1818
## Contributing large features
1919

2020
Larger features and all the features that affect the interface (CLI or API) of
21-
kpt need to have a reviewed and merged design document. It is OK to start with
22-
a prototype in your private fork but if you intend for your feature to be
23-
shipped in kpt please create a design document with this
21+
kpt components need to have a reviewed and merged design document. It is OK to
22+
start with a prototype in your private fork but if you intend for your feature
23+
to be shipped in kpt please create a design document with this
2424
[design template](/docs/design-docs/00-template.md).
2525

2626
You should create a copy of the template and submit a PR for comments and
@@ -39,14 +39,30 @@ information on using pull requests.
3939
This project follows [Google's Open Source Community Guidelines] and a [Code of
4040
Conduct].
4141

42+
## Community Discussion Groups
43+
44+
Join following groups/channels to discuss ideas with other kpt contributors.
45+
46+
1. Join our [email list](https://groups.google.com/forum/?oldui=1#!forum/kpt-dev)
47+
1. Join our [Slack channel](https://kubernetes.slack.com/channels/kpt)
48+
4249
## Style Guides
4350

4451
Contributions are required to follow these style guides:
4552

4653
- [Error Message Style Guide]
4754
- [Documentation Style Guide]
4855

49-
## Building the Source
56+
## Contributing to `kpt`
57+
58+
The kpt toolchain has several components such as `kpt CLI`, `package orchestrator`,
59+
`function catalog`, `function SDKs`, `Backstage UI plugin` and `config sync`. Each
60+
component has their own development process.
61+
Refer to the pointers below to learn more:
62+
63+
### kpt CLI
64+
65+
#### Building the Source
5066

5167
1. Clone the project
5268

@@ -67,18 +83,28 @@ Contributions are required to follow these style guides:
6783
make all
6884
```
6985

70-
## Contribution to the Functions Catalog
86+
### Package Orchestrator
87+
88+
Package orchestrator code live under `porch` directory in this repo. Please see the
89+
[developer docs for porch](porch/docs/development.md) to learn more.
90+
91+
### Function Catalog
7192

72-
Refer to the
93+
Function catalog has its own repository. Refer to the
7394
[documentation in the kpt-functions-catalog](https://github.com/GoogleContainerTools/kpt-functions-catalog/blob/master/CONTRIBUTING.md)
7495
repo.
7596

76-
## Contributing to Documentation
97+
### Config Sync
98+
99+
Config Sync has its own [repository](https://github.com/GoogleContainerTools/kpt-config-sync).
100+
Refer to the [documentation in the config-sync repo](https://github.com/GoogleContainerTools/kpt-config-sync/blob/main/docs/contributing.md).
101+
102+
### Documentation
77103

78104
If you are updating the documentation, please do it in separate PRs from code
79105
changes and PR description should start with `Docs:`.
80106

81-
### Run the docs locally
107+
#### Run the docs locally
82108

83109
Make docs changes and test them by running the site in a docker container with
84110
`make site-run-server`.
@@ -88,12 +114,12 @@ It's usually a good idea to test locally for the following:
88114
- Broken links
89115
- Rendering static content
90116

91-
### Update docs
117+
#### Update docs
92118

93119
Docs are under [site/] and use [docsify] to present the source markdown files.
94120
The sidebar is automatically updated for the site at deployment time.
95121

96-
### Docs Hygiene
122+
#### Docs Hygiene
97123

98124
The kpt website uses markdownlint to lint docs for formatting and style. Use
99125
prettier with the `"prettier.proseWrap": "always"` setting to auto-format docs

0 commit comments

Comments
 (0)