Skip to content

Commit 232bcd8

Browse files
authored
docs: Convert slack links to CNCF, add link to contributing guide (#117)
* docs: Convert slack links to CNCF, add link to contributing guide * updating the readme
1 parent 09ba7f3 commit 232bcd8

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to Cadence Samples
2+
3+
This doc is intended for contributors to Cadence samples. Thanks for considering to contribute ❤️
4+
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-samples specific setup and development instructions.
6+
7+
Once you go through the rest of this doc and get familiar with local development setup, take a look at the list of issues labeled with
8+
[good first issue](https://github.com/uber-common/cadence-samples/labels/good%20first%20issue).
9+
10+
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.
11+
12+
### Documentation
13+
14+
- Every sample must have a README.md
15+
- Include:
16+
- What the sample demonstrates
17+
- Real-world use cases
18+
- How to run the sample
19+
- Expected output
20+
- Key concepts
21+
22+
### Getting Help
23+
24+
If you need help or have questions:
25+
26+
- Join [CNCF Slack #cadence-users](https://communityinviter.com/apps/cloud-native/cncf)
27+
- Ask on [StackOverflow](https://stackoverflow.com/questions/tagged/cadence-workflow) with tag `cadence-workflow`
28+
- Open a [GitHub Discussion](https://github.com/uber-common/cadence-samples/discussions)
29+
- File an [issue](https://github.com/uber-common/cadence-samples/issues) for bugs
30+
31+
## Code of Conduct
32+
33+
Please be respectful and constructive in all interactions. We're all here to learn and help each other build better software.
34+
35+
## License
36+
37+
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.
38+
39+
---
40+
41+
Thank you for contributing to Cadence samples! Your efforts help the entire community. 🚀
42+

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Learn more about Cadence at:
1515
- [Documentation](https://cadenceworkflow.io)
1616
- [Cadence Server](https://github.com/cadence-workflow/cadence)
1717
- [Cadence Go Client](https://github.com/cadence-workflow/cadence-go-client)
18+
- [CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf) - Join **#cadence-users** channel on CNCF Slack
1819

1920
## 🚀 Quick Start
2021

0 commit comments

Comments
 (0)