Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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


> 📚 **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.

### Installation

Expand Down
59 changes: 0 additions & 59 deletions community/how-to-contribute/coding-conventions.mdx

This file was deleted.

31 changes: 31 additions & 0 deletions community/how-to-contribute/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Getting Started
---

# Getting Started

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.

## Join the Community

The best way to get started is to connect with the Cadence community:

### CNCF Slack Workspace

Join our community on the CNCF Slack workspace:
- **Join via**: [Community Inviter](https://communityinviter.com/apps/cloud-native/cncf)
- **Channel**: **#cadence-users**

This is the best place to ask questions, discuss features, and connect with maintainers and other contributors.

### Other Community Channels

- For general Q&A, support/help, and announcements see [GitHub Discussions](https://github.com/cadence-workflow/cadence/discussions)
- To report bugs or request new features use [GitHub Issues](https://github.com/cadence-workflow/cadence/issues)
- For specific code questions/bugs use [Stack Overflow](https://stackoverflow.com/questions/tagged/cadence-workflow)

## Contributing

We will continue fleshing out our contribution guide. Until then, refer to our repository README files for details.

Once you are ready to open a pull request, see [Pull Request Conventions](pull-request-conventions).
59 changes: 59 additions & 0 deletions community/how-to-contribute/pull-request-conventions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Pull Request Conventions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any convention to request review/response/merge, like in slack, or we will rely only on github?

---

# Pull Request Conventions

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.

## Pull Request Titles

### Conventional Commits Format

All pull request titles should follow the [Conventional Commits](https://www.conventionalcommits.org/) format:

```
<type>(<optional scope>): <description>

Examples:
feat(worker): Add batch processing API
fix(history): Resolve deadlock in workflow execution
docs: Update getting started guide
```

**Types:**
- **feat**: A new feature
- **fix**: A bug fix
- **docs**: Documentation only changes
- **refactor**: Code change that neither fixes a bug nor adds a feature
- **test**: Adding or updating tests
- **chore**: Changes to build process, dependencies, or tools

### PR Title Guidelines

Follow the [Chris Beams guide](http://chris.beams.io/posts/git-commit/) to writing git commit messages. All PR titles should:

- Start with UPPER case
- Be specific (avoid generic titles like "bug fixes")
- Use imperative mood ("Add feature" not "Added feature")

**Examples from Cadence repositories:**
- [Make sync activity retry multiple times before fetch history from remote](https://github.com/cadence-workflow/cadence/pull/1379)
- [Enable archival config per domain](https://github.com/cadence-workflow/cadence/pull/1351)

## Signing Commits

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:

- Signing every commit with `-s`: `git commit -s -m "Your commit message"`
- Signing each commit with a GPG key

### Setting up GPG key signing

1. [Generate a new GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
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)
3. [Tell Git about your signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key)
4. Enable automatic signing:
```bash
git config --global commit.gpgsign true
```
2 changes: 1 addition & 1 deletion community/support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Stack Overflow is a popular forum to ask code-level questions or if you're stuck

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.

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

## Feature requests {#feature-requests}

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -317,8 +317,8 @@ const config: Config = {
href: 'https://stackoverflow.com/questions/tagged/cadence-workflow+uber-cadence',
},
{
label: 'Cadence Community Slack',
href: 'http://t.uber.com/cadence-slack',
label: 'Cadence Community on CNCF Slack',
href: 'https://communityinviter.com/apps/cloud-native/cncf',
},
{
label: 'LinkedIn',
Expand Down
5 changes: 3 additions & 2 deletions sidebarsCommunity.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ export default {
label: 'How to Contribute',
items: [
{ type: 'doc', id: 'how-to-contribute/index' },
{ type: 'doc', id: 'how-to-contribute/coding-conventions' },
{ type: 'doc', id: 'how-to-contribute/getting-started' },
{ type: 'doc', id: 'how-to-contribute/pull-request-conventions' },
],
},
{ type: 'doc', id: 'governance' },
Expand All @@ -31,7 +32,7 @@ export default {
{
type: 'link',
label: 'Chat with us on Slack',
href: 'http://t.uber.com/cadence-slack',
href: 'https://communityinviter.com/apps/cloud-native/cncf',
},
{
type: 'link',
Expand Down