You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 5, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,35 +8,45 @@ If you face any issues while contributing or want any type of support, we encour
8
8
9
9
## Prerequisites
10
10
11
-
-[NodeJS](https://nodejs.org/) (LTS)
12
-
-[Yarn](https://yarnpkg.com/)
11
+
-[NodeJS](https://nodejs.org/) (LTS)
12
+
-[Yarn](https://yarnpkg.com/)
13
13
14
14
## Contributing to the docs
15
15
16
+
> [!NOTE]
17
+
> Contributions that only address relatively minor typographical errors are not accepted. If you believe you have identified an important typographical error that should be addressed, [please open an Issue](https://github.com/web3/web3.js/issues/new?assignees=&labels=Documentation&projects=&template=issue-template.md&title=[Typo]).
18
+
16
19
1.**Fork the docs:** Start by forking our repository to your GitHub account.
17
20
18
21
2.**Clone the repo:** Clone the forked repository to your local machine using the following command:
3.**Create a Branch:** Create a new branch for your changes with a descriptive name.
23
-
**NOTE: The branch name must include the issue number (if there is no issue created for your contribution, please create one).**
28
+
**NOTE: The branch name must include the issue number (if there is no issue created for your contribution, please create one).**
29
+
24
30
```bash
25
31
git checkout -b issue-name-1234
26
32
```
33
+
27
34
4.**Navigate to the docs folder:**`cd web3.js/docs/docs`
28
35
29
-
5.**Install dependencies:**
36
+
5.**Install dependencies:**
37
+
30
38
```bash
31
39
yarn
32
40
```
41
+
33
42
6.**Make your changes:**...
34
43
35
44
7. Check changes in the local environment: Run the command `yarn start` and you'll see a local environment in `localhost:3000` with the documents.
36
45
37
-
8.**Commit your changes:**`git add .` and `git commit -m 'descriptive msg'`
46
+
8.**Commit your changes:**`git add .` and `git commit -m 'descriptive msg'`
38
47
39
48
9.**Push your changes:**
49
+
40
50
```bash
41
51
git push origin branch-name
42
52
```
@@ -96,4 +106,3 @@ Emergency releases are allowed to shorten waiting periods depending on the sever
96
106
There is precedent set for this in the 1.2.6 release (see [#3351](https://github.com/ethereum/web3.js/pull/3351)), where the consensus view was to make the smallest change necessary to address the emergency while waiving the `rc` process (meaning many existing additions to master were excluded).
97
107
98
108
This topic is under further org-wide discussion at [ethereum/js-organization#6](https://github.com/ethereum/js-organization/issues/6).
Copy file name to clipboardExpand all lines: packages/web3-core/CHANGELOG.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ Documentation:
123
123
124
124
### Added
125
125
126
-
- Web3Subscription constructor accept a Subscription Manager (as an alternative to accepting Request Manager that is now marked marked as deprecated) (#6210)
126
+
- Web3Subscription constructor accept a Subscription Manager (as an alternative to accepting Request Manager that is now marked as deprecated) (#6210)
127
127
128
128
### Changed
129
129
@@ -185,7 +185,7 @@ Documentation:
185
185
186
186
- defaultTransactionType is now type 0x2 instead of 0x0 (#6282)
187
187
- Allows formatter to parse large base fee (#6456)
188
-
- The package now uses `EventEmitter` from `web3-utils` that works in node envrioment as well as in the browser. (#6398)
188
+
- The package now uses `EventEmitter` from `web3-utils` that works in node environment as well as in the browser. (#6398)
189
189
190
190
### Fixed
191
191
@@ -205,7 +205,7 @@ Documentation:
205
205
206
206
### Changed
207
207
208
-
- Web3config `contractDataInputFill` has been defaulted to `data`, istead of `input`. (#6622)
208
+
- Web3config `contractDataInputFill` has been defaulted to `data`, instead of `input`. (#6622)
209
209
210
210
## [4.4.0]
211
211
@@ -225,7 +225,7 @@ Documentation:
225
225
226
226
### Added
227
227
228
-
- Now when existing packages are added in web3, will be avalible for plugins via context. (#7088)
228
+
- Now when existing packages are added in web3, will be available for plugins via context. (#7088)
0 commit comments