Looking to contribute something to GraphCommerce? Here's how you can help.
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Well-written, thorough bug reports are a great way to contribute to the project. Before raising a new issue, please check our issues list ↗ to determine whether the issue you encountered has already been reported.
A good bug report should be self-explanatory. Use the bug report template ↗ to create a bug report.
Feature requests are welcome. Please take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince us of the merits of this feature.
Provide as much detail and context as possible. Use the feature request template ↗ to create a feature request.
Good pull requests (e.g. patches, improvements, new features) are a fantastic help. Please ask first ↗ before embarking on any significant pull request (e.g. implementing features or refactoring code), otherwise you risk spending a lot of time working on something that might not be relevant to the project.
File structure of GraphCommerce ├── docs ├── examples └── magento-graphcms ├── packages
To make changes to the magento-graphcms template, edit the files in examples/magento-graphcms.
To modify GraphCommerce framework, components, edit the files in packages/graphcommerce.
To make changes to the docs, edit the files in docs
GraphCommerce uses ESLint for linting and Prettier for code formatting. Install the recommended VS Code extensions
canarybranch. Use the following naming convention:
examples/magento-graphcmsshould be kept to a minimum, because every change made here must be applied by every developer upgrading a GraphCommerce project