@graphcommerce/docs 4.2.1 → 4.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Change Log
2
2
 
3
+ ## 4.4.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#1324](https://github.com/graphcommerce-org/graphcommerce/pull/1324) [`73d07c6bb`](https://github.com/graphcommerce-org/graphcommerce/commit/73d07c6bbf630a92e44a2b2baf14200eb6900db5) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Update docs, add new graphcms media url
8
+
9
+ ## 4.4.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#1320](https://github.com/graphcommerce-org/graphcommerce/pull/1320) [`2ecac6e06`](https://github.com/graphcommerce-org/graphcommerce/commit/2ecac6e06ad19257acfd18e9042c5f81f66b476e) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Sort order, add link to create feature request
14
+
15
+ ## 4.3.0
16
+
17
+ ### Minor Changes
18
+
19
+ - [#1311](https://github.com/graphcommerce-org/graphcommerce/pull/1311) [`af7c45d65`](https://github.com/graphcommerce-org/graphcommerce/commit/af7c45d650c4e1472933ab5393bb370195f3e708) Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Add contributing
20
+
3
21
  ## 4.2.1
4
22
 
5
23
  ### Patch Changes
@@ -0,0 +1,90 @@
1
+ # Contributing to GraphCommerce
2
+
3
+ Looking to contribute something to GraphCommerce? Here's how you can help.
4
+
5
+ Please take a moment to review this document in order to make the contribution
6
+ process easy and effective for everyone involved.
7
+
8
+ ### Bug reports
9
+
10
+ Well-written, thorough bug reports are a great way to contribute to the project.
11
+ Before raising a new issue, please check our
12
+ [issues list ↗](https://github.com/graphcommerce-org/graphcommerce/issues) to
13
+ determine whether the issue you encountered has already been reported.
14
+
15
+ A good bug report should be self-explanatory. Use the
16
+ [bug report template ↗](https://github.com/graphcommerce-org/graphcommerce/issues/new/choose)
17
+ to create a bug report.
18
+
19
+ ### Feature requests
20
+
21
+ Feature requests are welcome. Please take a moment to find out whether your idea
22
+ fits with the scope and aims of the project. It's up to you to make a strong
23
+ case to convince us of the merits of this feature.
24
+
25
+ Provide as much detail and context as possible. Use the
26
+ [feature request template ↗](https://github.com/graphcommerce-org/graphcommerce/issues/new/choose)
27
+ to create a feature request.
28
+
29
+ ## Pull requests
30
+
31
+ Good pull requests (e.g. patches, improvements, new features) are a fantastic
32
+ help. Please
33
+ [ask first ↗](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
34
+ before embarking on any significant pull request (e.g. implementing features or
35
+ refactoring code), otherwise you risk spending a lot of time working on
36
+ something that might not be relevant to the project.
37
+
38
+ ### File structure
39
+
40
+ ```txt
41
+ File structure of GraphCommerce
42
+
43
+ ├── docs
44
+ ├── examples
45
+ └── magento-graphcms
46
+ ├── packages
47
+ ```
48
+
49
+ - To make changes to the magento-graphcms template, edit the files in
50
+ examples/magento-graphcms.
51
+
52
+ - To modify GraphCommerce framework, components, edit the files in
53
+ packages/graphcommerce.
54
+
55
+ - To make changes to the docs, edit the files in docs
56
+
57
+ ### Formatting and Linting
58
+
59
+ GraphCommerce uses ESLint for linting and Prettier for code formatting. Install
60
+ the [recommended VS Code extensions](../docs/getting-started/vscode.md)
61
+
62
+ ### Contributor License Agreement
63
+
64
+ Please make sure you have signed our Contributor License Agreement. We are not
65
+ asking you to assign copyright to us, but to give us the right to distribute
66
+ your code without restriction. We ask this of all contributors in order to
67
+ assure our users of the origin and continuing existence of the code. You only
68
+ need to sign the CLA once.
69
+
70
+ ### Creating a pull request
71
+
72
+ 1. Create a pull request. The PR can stay open until you are ready to merge.
73
+ 2. Add your changes
74
+ 3. Add a changeset
75
+
76
+ - Run 'yarn changeset' and select minor bump. Commit the changeset that is
77
+ created.
78
+
79
+ <figure>
80
+
81
+ ![yarn changeset](https://user-images.githubusercontent.com/1251986/157868337-0fa27e88-cf35-4e38-a59c-72c72ef6b054.jpg)
82
+
83
+ <figcaption>Select minor bump when running `yarn changeset`</figcaption>
84
+ </figure>
85
+
86
+ ## Next steps
87
+
88
+ - Discuss your ideas in the public
89
+ [ Slack community. ↗](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
90
+ chat
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@graphcommerce/docs",
3
3
  "homepage": "https://www.graphcommerce.org/docs",
4
4
  "repository": "github:graphcommerce-org/graphcommerce/docs",
5
- "version": "4.2.1",
5
+ "version": "4.4.1",
6
6
  "sideEffects": true,
7
7
  "devDependencies": {
8
8
  "@graphcommerce/prettier-config-pwa": "^4.0.2"
package/readme.md CHANGED
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  menu: Overview
3
- order: getting-started,framework
3
+ order: getting-started,framework, contributing, roadmap
4
4
  metaTitle: Start React, Next.js Magento PWA development here - GraphCommerce
5
5
  metaDescription:
6
6
  'GraphCommerce is the open-source PWA Studio Magento 2 alternative.