diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..26cd35b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to Cadence Python Client + +This doc is intended for contributors to the Cadence Python Client. Thanks for considering to contribute ❤️ + +> 📚 **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 Python client specific setup and development instructions. + +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 +[good first issue](https://github.com/cadence-workflow/cadence-python-client/labels/good%20first%20issue). +These issues are a great way to start contributing to Cadence Python Client. + +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. + +## Submitting Pull Requests + +1. Fork the repository +2. Create a feature branch from `main` +3. Make your changes following the code quality guidelines above +4. Write or update tests as needed +5. Ensure all tests pass and there are no linting/type errors +6. Submit a pull request with a clear description of your changes + +## Getting Help + +- **GitHub Issues**: [Report bugs or request features](https://github.com/cadence-workflow/cadence-python-client/issues/new) +- **CNCF Slack**: Join the **#cadence-users** channel at [cloud-native.slack.com](https://communityinviter.com/apps/cloud-native/cncf) +- **Stack Overflow**: Tag questions with `cadence-workflow` + +## License + +By contributing to Cadence Python Client, you agree that your contributions will be licensed under the Apache 2.0 License. + diff --git a/README.md b/README.md index 7ea5032..9db7ee6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [Cadence](https://github.com/uber/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. +If you'd like to propose a new feature, first join the [CNCF Slack workspace](https://communityinviter.com/apps/cloud-native/cncf) in the **#cadence-users** channel to start a discussion. + `cadence-python-client` is the Python framework for authoring workflows and activities. ## Disclaimer