Skip to content

docs: document contributor naming standards #622

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.

Sign up for GitHub

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
aoshl1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document contributor naming standards #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,36 @@ Thanks for contributing to StellarYield, a Stellar-native DeFi yield aggregator

Issues with `status: needs-update` for more than 14 days may be re-opened for others.

### 🌿 Branch, Commit, and PR Naming

Use short, descriptive names that include the issue number when possible.

**Branches**

| Work type | Branch example |
|-----------|----------------|
| Feature | `feat/issue-540-contributor-naming` |
| Bug fix | `fix/issue-612-apy-rounding` |
| Docs | `docs/issue-540-pr-naming-guide` |
| Refactor | `refactor/issue-618-vault-service` |

**Commits**

Follow the conventional commit style:

```text
feat: add APY comparison export
fix: handle missing vault metadata
docs: document contributor PR naming
refactor: simplify yield route scoring
```

**Pull requests**

- Include the issue number in the title when it fits, for example `docs: document contributor naming standards (#540)`.
- Add `Closes #<issue-number>`, `Fixes #<issue-number>`, or `Resolves #<issue-number>` in the PR body so GitHub links and closes the issue on merge.
- Keep one PR focused on one issue unless a maintainer asks you to combine related work.

### 💻 Local Setup
Since StellarYield is a full-stack monorepo, ensure you have the correct environments set up for the stack you are touching:

Expand Down
24 changes: 19 additions & 5 deletions docs/contributor-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,19 +281,33 @@ git fetch upstream
git checkout -b feat/issue-<number>-short-description upstream/main
```

Examples:
Use a prefix that matches the type of work:

| Issue | Branch name |
|-------|------------|
| `#559` – contributor guide | `feat/issue-559-wave-contributor-docs` |
| `#611` – correlation middleware | `feat/issue-611-correlation-id-middleware` |
| Work type | Branch name |
|-----------|-------------|
| Feature | `feat/issue-611-correlation-id-middleware` |
| Bug fix | `fix/issue-612-apy-rounding` |
| Docs | `docs/issue-540-pr-naming-guide` |
| Refactor | `refactor/issue-618-vault-service` |

For PRs that address multiple related issues at once, list all numbers:

```
feat/issues-545-549-share-price-chart-and-manifest
```

Use conventional commit messages so reviewers can scan history quickly:

```text
feat: add APY comparison export
fix: handle missing vault metadata
docs: document contributor PR naming
refactor: simplify yield route scoring
```

PR titles should be short and include the issue number when it fits, for example
`docs: document contributor naming standards (#540)`.

### 5. Linking the issue in your PR

The PR body **must** include a closing keyword so GitHub (and Drips) can
Expand Down