-
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
Open
c-warren
wants to merge
4
commits into
cadence-workflow:master
Choose a base branch
from
c-warren:cwarren/cncfchanges
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+97
−65
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: Pull Request Conventions | ||
--- | ||
|
||
# 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 | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Is there any convention to request review/response/merge, like in slack, or we will rely only on github?