-
Notifications
You must be signed in to change notification settings - Fork 66
docs: Convert slack links to CNCF, add link to contributing guide #283
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.
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
Open
vishwa-uber
wants to merge
2
commits into
cadence-workflow:master
Choose a base branch
from
vishwa-uber:cncf_slack
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+86
−1
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # Contributing to Cadence Java Samples | ||
|
|
||
| We'd love your help in making Cadence great. There are a variety of ways to contribute: | ||
|
|
||
| ## Ways to Contribute | ||
|
|
||
| * **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) | ||
| * **Fix or report bugs** by opening [GitHub Issues](https://github.com/uber/cadence-java-samples/issues) or submitting a Pull Request | ||
| * **Add new samples** that demonstrate Cadence features or common use cases | ||
| * **Improve documentation** by fixing typos, adding examples, or clarifying instructions | ||
| * **Share your Cadence success stories** with the community | ||
|
|
||
| ## General Contributing Guide | ||
|
|
||
| Please review our shared [Cadence Contributing Guide](https://github.com/cadence-workflow/contributing) for: | ||
| * Code of Conduct | ||
| * Contributor License Agreement (CLA) | ||
| * General contribution guidelines | ||
| * Development workflow | ||
| * Testing requirements | ||
|
|
||
| ## Development Setup | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| * Java 8 or later | ||
| * Gradle (included via wrapper) | ||
| * Docker and Docker Compose (for running Cadence Server locally) | ||
|
|
||
| ### Building the Project | ||
|
|
||
| ```bash | ||
| ./gradlew build | ||
| ``` | ||
|
|
||
| ### Running Tests | ||
|
|
||
| ```bash | ||
| ./gradlew test | ||
| ``` | ||
|
|
||
| ### Code Style | ||
|
|
||
| This project uses Google Java Format. The build will automatically format your code, but you can also run: | ||
|
|
||
| ```bash | ||
| ./gradlew googleJavaFormat | ||
| ``` | ||
|
|
||
| ## Adding New Samples | ||
|
|
||
| When adding new samples: | ||
|
|
||
| 1. Place your sample code in the appropriate package under `src/main/java/com/uber/cadence/samples/` | ||
| 2. Add corresponding unit tests in `src/test/java/com/uber/cadence/samples/` | ||
| 3. Update the main [README.md](README.md) with instructions on how to run your sample | ||
| 4. If your sample is complex, consider adding a dedicated README.md in the sample's directory | ||
|
|
||
| ## Submitting Changes | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a feature branch from `master` | ||
| 3. Make your changes following the code style guidelines | ||
| 4. Add tests for your changes | ||
| 5. Ensure all tests pass: `./gradlew test` | ||
| 6. Commit your changes with a descriptive commit message | ||
| 7. Push to your fork and submit a Pull Request | ||
|
|
||
| ## Getting Help | ||
|
|
||
| If you have questions or need help: | ||
|
|
||
| * Join the `#cadence` channel on [CNCF Slack](https://slack.cncf.io/) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think the channel is called #cadence. I think it's #cadence-users |
||
| * Open a [GitHub Issue](https://github.com/uber/cadence-java-samples/issues) | ||
| * Check the [Cadence documentation](https://cadenceworkflow.io/docs/) | ||
|
|
||
| ## License | ||
|
|
||
| By contributing to Cadence Java Samples, you agree that your contributions will be licensed under the [MIT License](LICENSE.txt). | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you mind adding a link to the channel specifically? I think it's https://cloud-native.slack.com/archives/C09J2FQ7XU3