Skip to content

Commit 6d0d52b

Browse files
authored
[CATALYST-1686] Clarify REST Management API in Contributing (#2861)
* Update contributing doc to clarify not accepting PRs to integrate REST Management API * update broken links and text
1 parent 0633612 commit 6d0d52b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ The default branch for this repository is called `canary`. This is the primary d
1212

1313
To contribute to the `canary` branch, you can create a new branch off of `canary` and submit a PR against that branch.
1414

15+
## API Scope
16+
17+
Catalyst is intended to work with the [BigCommerce Storefront GraphQL API](https://developer.bigcommerce.com/docs/storefront/graphql) and not directly integrate out of the box with the [REST Management API](https://developer.bigcommerce.com/docs/rest-management).
18+
19+
You're welcome to integrate the REST Management API in your own fork, but we will not accept pull requests that incorporate or depend on the REST Management API. If your contribution requires Management API functionality, it is out of scope for this project.
20+
1521
## Makeswift Integration
1622

1723
In addition to `canary`, we also maintain the `integrations/makeswift` branch, which contains additional code required to integrate with [Makeswift](https://www.makeswift.com).

0 commit comments

Comments
 (0)