Skip to content

Commit 8dda09d

Browse files
authored
Merge branch 'main' into integration-test-1
2 parents e5d4013 + afef579 commit 8dda09d

File tree

4 files changed

+107
-0
lines changed

4 files changed

+107
-0
lines changed

.github/dco.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
require:
2+
members: false

.github/workflows/semantic-pr.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Semantic Pull Request
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
jobs:
11+
semantic-pr:
12+
name: Validate PR title follows conventional commit format
13+
runs-on: ubuntu-latest
14+
# TODO: Remove this once we commit to conventional commits
15+
continue-on-error: true
16+
17+
steps:
18+
- name: Validate PR title
19+
id: lint_pr_title
20+
uses: amannn/[email protected]
21+
with:
22+
# Allow standard conventional commit types
23+
types: |
24+
fix
25+
feat
26+
docs
27+
style
28+
refactor
29+
perf
30+
test
31+
chore
32+
ci
33+
build
34+
# TODO: Remove this once we've decided on scopes
35+
requireScope: false
36+
# Skip validation for certain labels if needed
37+
ignoreLabels: |
38+
skip-commit-format
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
42+
- name: Comment on PR if validation fails
43+
if: steps.lint_pr_title.outputs.error_message != null
44+
uses: actions/github-script@v7
45+
with:
46+
script: |
47+
github.rest.issues.createComment({
48+
issue_number: context.issue.number,
49+
owner: context.repo.owner,
50+
repo: context.repo.repo,
51+
body: `⚠️ **Semantic PR Check Failed**
52+
53+
**Error Details:**
54+
\`\`\`
55+
${{ steps.lint_pr_title.outputs.error_message }}
56+
\`\`\`
57+
58+
**Required Format:**
59+
\`\`\`
60+
<type>: <description>
61+
\`\`\`
62+
63+
**Allowed types:** fix, feat, docs, style, refactor, perf, test, chore, ci, build
64+
65+
**Examples:**
66+
- \`feat: add user authentication system\`
67+
- \`fix: resolve memory leak in worker pool\`
68+
- \`docs: update API documentation\`
69+
- \`test: add integration tests for auth flow\`
70+
71+
This is currently a **warning only** and won't block your PR from being merged.`
72+
})

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to Cadence Python Client
2+
3+
This doc is intended for contributors to the Cadence Python Client. 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 Python client 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/cadence-workflow/cadence-python-client/labels/good%20first%20issue).
9+
These issues are a great way to start contributing to Cadence Python Client.
10+
11+
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.
12+
13+
## Submitting Pull Requests
14+
15+
1. Fork the repository
16+
2. Create a feature branch from `main`
17+
3. Make your changes following the code quality guidelines above
18+
4. Write or update tests as needed
19+
5. Ensure all tests pass and there are no linting/type errors
20+
6. Submit a pull request with a clear description of your changes
21+
22+
## Getting Help
23+
24+
- **GitHub Issues**: [Report bugs or request features](https://github.com/cadence-workflow/cadence-python-client/issues/new)
25+
- **CNCF Slack**: Join the **#cadence-users** channel at [cloud-native.slack.com](https://communityinviter.com/apps/cloud-native/cncf)
26+
- **Stack Overflow**: Tag questions with `cadence-workflow`
27+
28+
## License
29+
30+
By contributing to Cadence Python Client, you agree that your contributions will be licensed under the Apache 2.0 License.
31+

README.md

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

33
[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.
44

5+
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.
6+
57
`cadence-python-client` is the Python framework for authoring workflows and activities.
68

79
## Disclaimer

0 commit comments

Comments
 (0)