The following is a set of guidelines for contributing to the Shopify App gem. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
Shopify has an official message board with dedicated forums to discuss all things apps, APIs, SDKs and more.
If you prefer to chat instead, join the Shopify Partners Slack Community group. This Slack group hosts an active community of thousands of app developers.
By participating in the Community forum or Slack group, you agree to adhere to the forum Code of Conduct outlined.
This section guides you through submitting a bug report for the Shopify App gem. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
- Check the troubleshooting guide. You may be able to troubleshoot the issue you're facing.
- Check the Shopify Community links to search for your issue. This problem may have been reported before and solved on the Shopify forum.
- Perform a cursory search for similar issues. You may find that the same problem (or a similar one) has been filed already as an issue.
Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the bug-report template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. Include links to files, or copy/pasteable snippets. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs where possible.
- Redact any private information from your logs and issue description. This includes things like API keys, API secrets, and any access tokens.
If you have a suggestion for the Shopify App gem or a feature request, provide the appropriate information by filling out the feature-request template.
The process described here has several goals:
- Maintain the Shopify App gem's quality (does the change you're making have a test?)
- Fix problems that are important to app developers
- Enable a sustainable system for the Shopify App gem's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the pull request template
- After you submit your pull request, verify that all status checks are passing
-
What if the status checks are failing?
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
-
To run tests, you'll need to make sure that your development environment is setup correctly. You'll need:
- Ruby 3+ is installed on your system
- Install dependencies with
bundle install
- To run all tests:
bundle exec rake test - To run a specific test file:
bundle exec rake test TEST=test/controllers/callback_controller_test.rb - To run a single test:
bundle exec rake test TEST=test/controllers/callback_controller_test.rb:50where50is the line number on or inside the test case.