-
Notifications
You must be signed in to change notification settings - Fork 84
docs: Add getting started guide, udpate pull request conventions #294
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
Changes from 3 commits
3bb9eaf
3a11c79
e1b79ca
e05c275
7eb70e1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Getting Started Contributing | ||
--- | ||
|
||
# Getting Started Contributing | ||
|
||
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: | ||
- **Workspace**: [cloud-native.slack.com](https://cloud-native.slack.com/) | ||
- **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) | ||
Comment on lines
+23
to
+25
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. Taken from the Cadence README |
||
|
||
## 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). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: Pull Request Conventions | ||
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. Is there any convention to request review/response/merge, like in slack, or we will rely only on github? 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've messaged the GitHub team to see if we can combine our open-source and closed-source queues, but I think we will have to rely on GitHub to some extent for open source contributions from anyone external to Uber. I also think we should decide on some conventions/tools around assigning PRs using Github, and we can add that to this document when we have those conventions figured out. (My proposal is that we:
But I don't have buy in for that yet) |
||
--- | ||
|
||
# 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 | ||
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. This is the only addition, the rest was moved from 'coding conventions' |
||
|
||
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 | ||
``` |
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.
Example of what we can add to other repos to get people started.