Skip to content

Commit f75984c

Browse files
committed
docs: Convert slack links to CNCF, add link to contributing guide
Signed-off-by: [email protected] <[email protected]>
1 parent a18f4f3 commit f75984c

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contributing to Cadence Java Samples
2+
3+
We'd love your help in making Cadence great. There are a variety of ways to contribute:
4+
5+
## Ways to Contribute
6+
7+
* **Try out Cadence** and share your feedback via [CNCF Slack](https://slack.cncf.io/) or [GitHub Issues](https://github.com/uber/cadence-java-samples/issues)
8+
* **Fix or report bugs** by opening [GitHub Issues](https://github.com/uber/cadence-java-samples/issues) or submitting a Pull Request
9+
* **Add new samples** that demonstrate Cadence features or common use cases
10+
* **Improve documentation** by fixing typos, adding examples, or clarifying instructions
11+
* **Share your Cadence success stories** with the community
12+
13+
## General Contributing Guide
14+
15+
Please review our shared [Cadence Contributing Guide](https://github.com/cadence-workflow/contributing) for:
16+
* Code of Conduct
17+
* Contributor License Agreement (CLA)
18+
* General contribution guidelines
19+
* Development workflow
20+
* Testing requirements
21+
22+
## Development Setup
23+
24+
### Prerequisites
25+
26+
* Java 8 or later
27+
* Gradle (included via wrapper)
28+
* Docker and Docker Compose (for running Cadence Server locally)
29+
30+
### Building the Project
31+
32+
```bash
33+
./gradlew build
34+
```
35+
36+
### Running Tests
37+
38+
```bash
39+
./gradlew test
40+
```
41+
42+
### Code Style
43+
44+
This project uses Google Java Format. The build will automatically format your code, but you can also run:
45+
46+
```bash
47+
./gradlew googleJavaFormat
48+
```
49+
50+
## Adding New Samples
51+
52+
When adding new samples:
53+
54+
1. Place your sample code in the appropriate package under `src/main/java/com/uber/cadence/samples/`
55+
2. Add corresponding unit tests in `src/test/java/com/uber/cadence/samples/`
56+
3. Update the main [README.md](README.md) with instructions on how to run your sample
57+
4. If your sample is complex, consider adding a dedicated README.md in the sample's directory
58+
59+
## Submitting Changes
60+
61+
1. Fork the repository
62+
2. Create a feature branch from `master`
63+
3. Make your changes following the code style guidelines
64+
4. Add tests for your changes
65+
5. Ensure all tests pass: `./gradlew test`
66+
6. Commit your changes with a descriptive commit message
67+
7. Push to your fork and submit a Pull Request
68+
69+
## Getting Help
70+
71+
If you have questions or need help:
72+
73+
* Join the `#cadence` channel on [CNCF Slack](https://slack.cncf.io/)
74+
* Open a [GitHub Issue](https://github.com/uber/cadence-java-samples/issues)
75+
* Check the [Cadence documentation](https://cadenceworkflow.io/docs/)
76+
77+
## License
78+
79+
By contributing to Cadence Java Samples, you agree that your contributions will be licensed under the [MIT License](LICENSE.txt).
80+

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,7 @@ To run:
140140
# register domain
141141
./gradlew -q execute -PmainClass=com.uber.cadence.samples.common.RegisterDomain
142142
./gradlew -q execute -PmainClass=com.uber.cadence.samples.spring.CadenceSamplesApplication
143+
144+
## Contributing
145+
146+
We'd love your help in making Cadence great. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute.

0 commit comments

Comments
 (0)