Skip to content

Commit c4523ac

Browse files
authored
Update contribution guidelines for commit scopes
Clarify scope requirements for commits and pull requests in SDK.
1 parent cce37a9 commit c4523ac

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Create a branch with a descriptive name, such as `add-search`.
4949

5050
We use [semantic-versioning](https://semver.org/) and the [conventional commit message format](https://www.conventionalcommits.org/en/v1.0.0/). Keep a separate feature branch for each issue you want to address. As you develop code, continue to push code to your remote feature branch.
5151

52-
**Important:** When modifying or adding features for a specific part of the SDK, commits and pull requests should include a scope. The scope must be either `boxsdk` or `boxsdkgen`. For general changes that don't affect a specific part (e.g., documentation updates, build configuration), the scope is optional. Examples:
52+
**Important:** When editing the manual part of the SDK, commits and pull requests should include the `boxsdk` scope. For general changes that don't affect a specific part (e.g., documentation updates, build configuration), the scope is optional. Examples:
5353

5454
```
5555
tag(scope): short description
@@ -60,15 +60,15 @@ longer description here if necessary.
6060

6161
Examples with scope:
6262
- `feat(boxsdk): add new file upload feature`
63-
- `fix(boxsdkgen): correct type definitions`
63+
- `fix(boxsdk): correct type definitions`
6464
- `feat(boxsdk)!: remove deprecated endpoints`
6565

6666
Examples without scope:
6767
- `docs: update README`
6868
- `chore: update build configuration`
6969
- `ci: fix GitHub Actions workflow`
7070

71-
The message summary should be a one-sentence description of the change, and it must be 72 characters in length or shorter. For a list of tags, please [click here](https://github.com/commitizen/conventional-commit-types/blob/master/index.json). Note that you must include the `!` for breaking changes (e.g. `feat(boxsdk)!: removed old apis` or `feat!: breaking change` for general changes).
71+
The message summary should be a one-sentence description of the change, and it must be 72 characters in length or shorter. For a list of tags, please [click here](https://github.com/commitizen/conventional-commit-types/blob/master/index.json). Note that you must include the `!` for breaking changes (e.g. `feat(boxsdk)!: removed old apis` for changes in manual part of the SDK or `feat!: breaking change` for general changes).
7272

7373
Shown below are examples of the release type that will be done based on a commit message.
7474

@@ -90,7 +90,7 @@ In most cases, commits will be a `feat` or `fix`. Make sure to include the `!` i
9090
| Commit message | Release type | New version |
9191
| ------------------------------------------------------- | ------------------ | ----------- |
9292
| `feat(boxsdk)!: remove old files endpoints` | Major ("breaking") | `X+1.0.0` |
93-
| `feat(boxsdkgen): add new file upload endpoint` | Minor ("feature") | `X.Y+1.0` |
93+
| `feat(boxsdk): add new file upload endpoint` | Minor ("feature") | `X.Y+1.0` |
9494
| `fix(boxsdk): file streaming during download` | Patch ("fix") | `X.Y.Z+1` |
9595
| `docs: update README` | No release | `X.Y.Z` |
9696
| `chore: update build configuration` | No release | `X.Y.Z` |

0 commit comments

Comments
 (0)