Skip to content

Commit 5bb1376

Browse files
authored
Merge branch 'master' into cwarren/upgradedocusaurusv2
2 parents 84f6f5c + c41d3a7 commit 5bb1376

File tree

7 files changed

+97
-65
lines changed

7 files changed

+97
-65
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
[Cadence docs](https://cadenceworkflow.io) is built using [Docusaurus](https://docusaurus.io/).
88

9-
9+
> 📚 **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 backend specific setup and development instructions.
1010
1111
### Installation
1212

community/how-to-contribute/coding-conventions.mdx

Lines changed: 0 additions & 59 deletions
This file was deleted.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Getting Started
3+
---
4+
5+
# Getting Started
6+
7+
Thank you for your interest in contributing to Cadence! We're excited to have you join our community. This guide will help you get started with contributing to any Cadence repository.
8+
9+
## Join the Community
10+
11+
The best way to get started is to connect with the Cadence community:
12+
13+
### CNCF Slack Workspace
14+
15+
Join our community on the CNCF Slack workspace:
16+
- **Join via**: [Community Inviter](https://communityinviter.com/apps/cloud-native/cncf)
17+
- **Channel**: **#cadence-users**
18+
19+
This is the best place to ask questions, discuss features, and connect with maintainers and other contributors.
20+
21+
### Other Community Channels
22+
23+
- For general Q&A, support/help, and announcements see [GitHub Discussions](https://github.com/cadence-workflow/cadence/discussions)
24+
- To report bugs or request new features use [GitHub Issues](https://github.com/cadence-workflow/cadence/issues)
25+
- For specific code questions/bugs use [Stack Overflow](https://stackoverflow.com/questions/tagged/cadence-workflow)
26+
27+
## Contributing
28+
29+
We will continue fleshing out our contribution guide. Until then, refer to our repository README files for details.
30+
31+
Once you are ready to open a pull request, see [Pull Request Conventions](pull-request-conventions).
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Pull Request Conventions
3+
---
4+
5+
# Pull Request Conventions
6+
7+
This page outlines pull request conventions and standards across Cadence repositories. For language-specific tooling, build instructions, and formatting details, refer to the CONTRIBUTING.md file in each repository.
8+
9+
## Pull Request Titles
10+
11+
### Conventional Commits Format
12+
13+
All pull request titles should follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
14+
15+
```
16+
<type>(<optional scope>): <description>
17+
18+
Examples:
19+
feat(worker): Add batch processing API
20+
fix(history): Resolve deadlock in workflow execution
21+
docs: Update getting started guide
22+
```
23+
24+
**Types:**
25+
- **feat**: A new feature
26+
- **fix**: A bug fix
27+
- **docs**: Documentation only changes
28+
- **refactor**: Code change that neither fixes a bug nor adds a feature
29+
- **test**: Adding or updating tests
30+
- **chore**: Changes to build process, dependencies, or tools
31+
32+
### PR Title Guidelines
33+
34+
Follow the [Chris Beams guide](http://chris.beams.io/posts/git-commit/) to writing git commit messages. All PR titles should:
35+
36+
- Start with UPPER case
37+
- Be specific (avoid generic titles like "bug fixes")
38+
- Use imperative mood ("Add feature" not "Added feature")
39+
40+
**Examples from Cadence repositories:**
41+
- [Make sync activity retry multiple times before fetch history from remote](https://github.com/cadence-workflow/cadence/pull/1379)
42+
- [Enable archival config per domain](https://github.com/cadence-workflow/cadence/pull/1351)
43+
44+
## Signing Commits
45+
46+
The Developer Certificate of Origin (DCO) requires all commits to be signed before they can be merged to Cadence repositories. You can fulfill this requirement using either:
47+
48+
- Signing every commit with `-s`: `git commit -s -m "Your commit message"`
49+
- Signing each commit with a GPG key
50+
51+
### Setting up GPG key signing
52+
53+
1. [Generate a new GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
54+
2. [Add GPG key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)
55+
3. [Tell Git about your signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key)
56+
4. Enable automatic signing:
57+
```bash
58+
git config --global commit.gpgsign true
59+
```

community/support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stack Overflow is a popular forum to ask code-level questions or if you're stuck
1313

1414
There are many online forums for discussion about best practices and application architecture as well as the future of Cadence. If you have an answerable code-level question, Stack Overflow is usually a better fit.
1515

16-
- [Cadence Community Slack](http://t.uber.com/cadence-slack)
16+
- [Cadence Community on CNCF Slack](https://communityinviter.com/apps/cloud-native/cncf) - Join the **#cadence-users** channel
1717

1818
## Feature requests {#feature-requests}
1919

docusaurus.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -317,8 +317,8 @@ const config: Config = {
317317
href: 'https://stackoverflow.com/questions/tagged/cadence-workflow+uber-cadence',
318318
},
319319
{
320-
label: 'Cadence Community Slack',
321-
href: 'http://t.uber.com/cadence-slack',
320+
label: 'Cadence Community on CNCF Slack',
321+
href: 'https://communityinviter.com/apps/cloud-native/cncf',
322322
},
323323
{
324324
label: 'LinkedIn',

sidebarsCommunity.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ export default {
1111
label: 'How to Contribute',
1212
items: [
1313
{ type: 'doc', id: 'how-to-contribute/index' },
14-
{ type: 'doc', id: 'how-to-contribute/coding-conventions' },
14+
{ type: 'doc', id: 'how-to-contribute/getting-started' },
15+
{ type: 'doc', id: 'how-to-contribute/pull-request-conventions' },
1516
],
1617
},
1718
{ type: 'doc', id: 'governance' },
@@ -31,7 +32,7 @@ export default {
3132
{
3233
type: 'link',
3334
label: 'Chat with us on Slack',
34-
href: 'http://t.uber.com/cadence-slack',
35+
href: 'https://communityinviter.com/apps/cloud-native/cncf',
3536
},
3637
{
3738
type: 'link',

0 commit comments

Comments
 (0)