Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.35 KB
Raw

Contributing to ShopifyQL Skill

Thank you for your interest in contributing to this project. This guide will help you get started.

Ways to Contribute

  • Report bugs: Found something that does not work? Let us know.
  • Suggest examples: Have a useful ShopifyQL query? Share it with the community.
  • Improve documentation: Help make the docs clearer and more helpful.
  • Add table support: Help expand coverage of ShopifyQL tables and fields.

Bug Reports

When reporting a bug, please:

  1. Use the bug report issue template
  2. Include the ShopifyQL query that caused the issue
  3. Copy the full error message
  4. Specify your Python version
  5. Include your SDK version and operating system

The more detail you provide, the faster we can help.

Adding ShopifyQL Examples

We welcome example queries from the community. To add an example:

  1. Place your example in the examples/ folder
  2. Follow the existing format used by other examples
  3. Include a comment explaining what the query does
  4. Test your query to ensure it works

Pull Request Process

  1. Fork the repository
  2. Create a branch from main
  3. Keep your PR focused on a single change
  4. Write clear commit messages
  5. Ensure all tests pass
  6. Update documentation if needed

Questions

Have questions that are not covered here?