-
Notifications
You must be signed in to change notification settings - Fork 482
expanded CONTRIBUTING instructions #1230
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
Merged
Merged
Changes from 2 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,34 @@ | ||
|
|
||
| Submitting Issues | ||
| ----------------- | ||
| Submitting Issues | ||
|
|
||
| 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. | ||
|
|
||
| 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). | ||
|
|
||
| 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. | ||
|
|
||
| In order for us to best triage the issue, please include steps to reproduce the issue as well as the impacted feature. | ||
|
|
||
| ## Roadmap | ||
|
|
||
| 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. | ||
|
|
||
| Working with a pull request modify the 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. | ||
|
|
||
| If there are concerns with the direction and priorities of the maintainers, this roadmap PR is the appropriate place to share your concerns. | ||
|
|
||
| ## Submitting Pull Requests | ||
|
|
||
| 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. | ||
|
|
||
| ## Gem Architecture | ||
| 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: | ||
|
|
||
| | Gem Name | Job | | ||
| |---|---| | ||
| | Shopify API (this gem) | Obtain a session, clients for APIs (REST, GraphQL), error handling, webhook management | | ||
| | REST Resources | Interfaces to the APIs. Response casting into defined objects with attributes/methods | | ||
| | Shopify App | Build Shopify app using Rails conventions. Oauth, webhook processing, persistence, etc | | ||
| | App Template | Template demonstrating how to use all these components in one starting boilerplate application | | ||
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.
Uh oh!
There was an error while loading. Please reload this page.