Skip to content

Commit bcb44ca

Browse files
authored
docs: contribution guide and summarizes the latest changes (#468)
* fix: replace all the old package name occurrences * fix: remove changeset files * docs: adds a simple contribution guide * docs: adds a changeset overviewing the missing changelogs * docs: adds changeset version command
1 parent 941643a commit bcb44ca

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed

.changeset/neat-feet-allow.md

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
"@module-federation/dashboard-plugin": patch
3+
---
4+
5+
Huge overview of latest changes, this change also introduces a contribution guide to help contributors understand the process of creating new changesets and PRs.
6+
7+
### Commits on Sep 13, 2023:
8+
9+
Added a new feature to enable cache buster.
10+
Updated a client version file.
11+
Made some code style fixes and removed comments.
12+
13+
### Commits on Sep 6, 2023:
14+
15+
Fixed changeset.
16+
Merged changes from the remote master branch.
17+
18+
### Commits on Sep 1, 2023:
19+
20+
Added a feature related to timeout and fallback for the client version.
21+
22+
### Commits on Jun 29, 2023:
23+
24+
Made a version update.
25+
Made changes related to Medusa delegate.
26+
27+
### Commits on Jan 18, 2023:
28+
29+
Added Medusa delegate modules.
30+
31+
### Commits on Nov 2, 2022:
32+
33+
Made various fixes and updates.
34+
Fixed issues related to CI and webpack.
35+
Removed old package names and changeset files.
36+
37+
### Commits on Sep 22, 2022:
38+
39+
Created new apps and plugins for testing.
40+
41+
### Commits on Aug 10, 2022:
42+
43+
Made version updates and fixed webpack errors.
44+
45+
### Commits on Aug 9, 2022:
46+
47+
Made various updates and fixes.
48+
Updated Node.js and dependencies.
49+
50+
### Commits on Jul 13, 2022:
51+
52+
Made changes related to version strategy.
53+
54+
### Commits on Jul 11, 2022:
55+
56+
Added support for Next.js.
57+
Updated dependencies like serve and node-fetch.
58+
Fixed temporary issues.
59+
60+
### Commits on Jul 8, 2022:
61+
62+
Updated injector to load the remote in a simpler format.
63+
Removed GraphQL from an API endpoint.
64+
Fixed token issues.
65+
66+
### Commits on Jul 6, 2022:
67+
68+
Added Git SHA to objects.
69+
Enabled stats file output.
70+
Made various updates and fixes.
71+
72+
### Commits on Jul 1, 2022:
73+
74+
Updated endpoints.
75+
76+
### Commits on Jun 27, 2022:
77+
78+
Made version updates.
79+
Updated injector and API to serve a simpler format for loading the remote.
80+
81+
### Commits on May 6, 2022:
82+
83+
Fixed configurations to help setup work.
84+
85+
### Commits on Apr 22, 2022:
86+
87+
Fixed database store.
88+
89+
### Commits on Mar 17, 2022:
90+
91+
Updated dependencies and fixed build issues.
92+
Added timers for debugging.
93+
94+
### Commits on Jan 11, 2022:
95+
96+
Updated less dependency.
97+
98+
### Commits on Oct 29, 2021:
99+
100+
Updated Yarn and webpack dependencies.
101+
102+
### Commits on Sep 24, 2021:
103+
104+
Fixed issues related to plugin tokens.
105+
106+
### Commits on Sep 21, 2021:
107+
108+
Added more timers for debugging.
109+
Made changes to cache settings.
110+
111+
### Commits on Sep 20, 2021:
112+
113+
Made various changes to cache settings, prefetch, and public cache.
114+
115+
### Commits on Sep 19, 2021:
116+
117+
Made changes to buttons, cache headers, and JSON bindings.
118+
Added new remote versions and endpoints.
119+
This summary provides an overview of the changes made in the repository, including new features, bug fixes, dependency updates, and other improvements.

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Thanks you for your contribution!
2+
3+
## commits
4+
5+
- must be followed by conventional commits
6+
7+
## version release
8+
9+
The project is using changesets to manage the versioning, so you need to create a changeset file before creating a PR, you can do that by running the following command:
10+
11+
```bash
12+
yarn changeset
13+
yarn changeset version
14+
```
15+
16+
After providing the necessary information, a changeset file will be created in the `.changeset` folder, you need to commit this file with your changes.
17+
18+
## PR
19+
20+
After creating a PR, the CI will run the tests and linting, if everything is ok, the PR will be merged to the `main` branch.
21+
22+
## release
23+
24+
After merging the PR to the `main` branch, the CI will run the tests and linting, if everything is ok, the CI will create a new release and publish it to the npm registry.

0 commit comments

Comments
 (0)