Skip to content

Commit 2c75b01

Browse files
vishwa-uberAssem-Uberadhityamamallan
authored
docs: Convert slack links to CNCF, add link to contributing guide (#1047)
Co-authored-by: Assem Hafez <[email protected]> Co-authored-by: Adhitya Mamallan <[email protected]>
1 parent 830b05e commit 2c75b01

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
This doc is intended for contributors to `cadence-web`
44

5+
> 📚 **New to contributing to Cadence?** Check out our [Contributing Guide](https://cadenceworkflow.io/community/how-to-contribute/getting-started) for an overview of the contribution process across all Cadence repositories. This document contains cadence-web specific setup and development instructions.
6+
7+
Once you go through the rest of this doc and get familiar with local development setup, feel free to start contributing!
8+
9+
Join our community on the CNCF Slack workspace at [cloud-native.slack.com](https://communityinviter.com/apps/cloud-native/cncf) in the **#cadence-users** channel to reach out and discuss issues with the team.
10+
511
**Note:** All contributors will be asked to sign [Uber Contributor License Agreement](http://t.uber.com/cla) during the PR process.
612

713
## Development Environment

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Cadence Web UI
22

33
[![Build Status](https://github.com/uber/cadence-web/actions/workflows/build.yml/badge.svg)](https://github.com/uber/cadence-web/actions/workflows/build.yml) [![Docker Status](https://github.com/uber/cadence-web/actions/workflows/docker_publish.yml/badge.svg)](https://hub.docker.com/r/ubercadence/web/tags)
4+
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://communityinviter.com/apps/cloud-native/cncf)
45

56
Cadence is a distributed, scalable, durable, and highly available orchestration engine we developed at Uber Engineering to execute asynchronous long-running business logic in a scalable and resilient way.
67

@@ -165,6 +166,12 @@ After running `cadence`, start `cadence-web` for development using one of the pr
165166
| lint | Run eslint |
166167
| typecheck | Run typescript checks |
167168

169+
## Contributing
170+
171+
We'd love your help in making the Cadence Web UI great. Please review our [contribution guidelines](CONTRIBUTING.md).
172+
173+
If you'd like to propose a new feature or discuss issues, join the [CNCF Slack workspace](https://communityinviter.com/apps/cloud-native/cncf) in the **#cadence-users** channel to start a discussion.
174+
168175
## License
169176

170177
Apache 2.0 License, please see [LICENSE](https://github.com/cadence-workflow/cadence-web/blob/master/LICENSE) for details.

0 commit comments

Comments
 (0)