@graphcommerce/docs 4.2.1 → 4.3.0
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 +6 -0
- package/contributing.md +87 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
3
|
+
## 4.3.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#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
|
|
8
|
+
|
|
3
9
|
## 4.2.1
|
|
4
10
|
|
|
5
11
|
### Patch Changes
|
package/contributing.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
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. But 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. Please provide as much detail
|
|
24
|
+
and context as possible.
|
|
25
|
+
|
|
26
|
+
## Pull requests
|
|
27
|
+
|
|
28
|
+
Good pull requests (e.g. patches, improvements, new features) are a fantastic
|
|
29
|
+
help. Please
|
|
30
|
+
[ask first ↗](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
|
|
31
|
+
before embarking on any significant pull request (e.g. implementing features or
|
|
32
|
+
refactoring code), otherwise you risk spending a lot of time working on
|
|
33
|
+
something that might not be relevant to the project.
|
|
34
|
+
|
|
35
|
+
### File structure
|
|
36
|
+
|
|
37
|
+
```txt
|
|
38
|
+
File structure of GraphCommerce
|
|
39
|
+
|
|
40
|
+
├── docs
|
|
41
|
+
├── examples
|
|
42
|
+
└── magento-graphcms
|
|
43
|
+
├── packages
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
- To make changes to the magento-graphcms template, edit the files in
|
|
47
|
+
examples/magento-graphcms.
|
|
48
|
+
|
|
49
|
+
- To modify GraphCommerce framework, components, edit the files in
|
|
50
|
+
packages/graphcommerce.
|
|
51
|
+
|
|
52
|
+
- To make changes to the docs, edit the files in docs
|
|
53
|
+
|
|
54
|
+
### Formatting and Linting
|
|
55
|
+
|
|
56
|
+
GraphCommerce uses ESLint for linting and Prettier for code formatting. Install
|
|
57
|
+
the [recommended VS Code extensions](../docs/getting-started/vscode.md)
|
|
58
|
+
|
|
59
|
+
### Contributor License Agreement
|
|
60
|
+
|
|
61
|
+
Please make sure you have signed our Contributor License Agreement. We are not
|
|
62
|
+
asking you to assign copyright to us, but to give us the right to distribute
|
|
63
|
+
your code without restriction. We ask this of all contributors in order to
|
|
64
|
+
assure our users of the origin and continuing existence of the code. You only
|
|
65
|
+
need to sign the CLA once.
|
|
66
|
+
|
|
67
|
+
### Creating a pull request
|
|
68
|
+
|
|
69
|
+
1. Create a pull request. The PR can stay open until you are ready to merge.
|
|
70
|
+
2. Add your changes
|
|
71
|
+
3. Add a changeset
|
|
72
|
+
|
|
73
|
+
- Run 'yarn changeset' and select minor bump. Commit the changeset that is
|
|
74
|
+
created.
|
|
75
|
+
|
|
76
|
+
<figure>
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<figcaption>Select minor bump when running `yarn changeset`</figcaption>
|
|
81
|
+
</figure>
|
|
82
|
+
|
|
83
|
+
## Next steps
|
|
84
|
+
|
|
85
|
+
- Discuss your ideas in the public
|
|
86
|
+
[ Slack community. ↗](https://join.slack.com/t/graphcommerce/shared_invite/zt-11rmgq1ad-F~0daNtKcSvtcC4eQRzjeQ)
|
|
87
|
+
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.
|
|
5
|
+
"version": "4.3.0",
|
|
6
6
|
"sideEffects": true,
|
|
7
7
|
"devDependencies": {
|
|
8
8
|
"@graphcommerce/prettier-config-pwa": "^4.0.2"
|