Skip to content

Commit 71fb48b

Browse files
nelsonwittwergarethson
authored andcommitted
expanded CONTRIBUTING instructions (Shopify#1230)
* expanded CONTRIBUTING instructions * permalink roadmap link
1 parent 9cefdad commit 71fb48b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,34 @@
11

22
Submitting Issues
33
-----------------
4+
Submitting Issues
45

56
Please open an issue here if you encounter a specific bug with this API client library or if something is documented here https://shopify.dev/docs/apps but is missing from this package.
67

78
General questions about the Shopify API and usage of this package (not necessarily a bug) should be posted on the [Shopify forums](https://community.shopify.com/c/partners-and-developers/ct-p/appdev).
89

910
When in doubt, post on the forum first. You'll likely have your questions answered more quickly if you post there; more people monitor the forum than Github.
11+
12+
In order for us to best triage the issue, please include steps to reproduce the issue as well as the impacted feature.
13+
14+
## Roadmap
15+
16+
The focus of development efforts by maintainers of this project a roadmap will be proposed via PR and accessible at any point in the ROADMAP.md file.
17+
18+
Working with a pull request modify the [ROADMAP.md](https://github.com/Shopify/shopify-api-ruby/blob/aa0b7f9a5a9095ca11f3f93f9aecc72e8daa6bce/ROADMAP.md) allows us to invite community feedback on the direction while not adding another communication avenue. While there are certainly better tools for the job than a markdown file for this, we are aiming to keep a minimal toolset to help us better manage the communication channels that we have open.
19+
20+
If there are concerns with the direction and priorities of the maintainers, this roadmap PR is the appropriate place to share your concerns.
21+
22+
## Submitting Pull Requests
23+
24+
We welcome pull requests and help from the community! PRs fixing bugs will take priority to triaging proposed net new functionality. If you do want to add a feature, we recommend opening an issue first exploring the appetite of the community / maintainers to ensure there is alignment on direction before you spend time on the PR.
25+
26+
## Gem Architecture
27+
Understanding how all the components of the Shopify App development stack work together will help best understand what level of abstraction a feature is meant to be applied. Please consider this architecture before introducing new functionally to ensure it is in the right place:
28+
29+
| Gem Name | Job |
30+
|---|---|
31+
| Shopify API (this gem) | Obtain a session, clients for APIs (REST, GraphQL), error handling, webhook management |
32+
| REST Resources | Interfaces to the APIs. Response casting into defined objects with attributes/methods |
33+
| Shopify App | Build Shopify app using Rails conventions. Oauth, webhook processing, persistence, etc |
34+
| App Template | Template demonstrating how to use all these components in one starting boilerplate application |

0 commit comments

Comments
 (0)