Skip to content

Commit 01e6a5e

Browse files
DamianFigielDamianFigiel
authored
fix: Add missing changelogs. Fix rush.json repository url. Add changelog instructions to README. (#398)
1 parent 96d09da commit 01e6a5e

File tree

13 files changed

+93
-15
lines changed

13 files changed

+93
-15
lines changed

‎README.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,31 @@ Subsquid is an OpenSource project, contributions are welcomed, encouraged and wi
3333

3434
Please consult [CONTRIBUTING.md](CONTRIBUTING.md) for hacking instructions
3535
and make sure to read our [code of conduct](CODE_OF_CONDUCT.md).
36+
37+
### Change Management
38+
39+
This project uses [Rush](https://rushjs.io/) for monorepo management. When making changes to packages, you need to document them using the rush change system:
40+
41+
1. **After making your changes and committing them**, run:
42+
```bash
43+
rush change -b origin/master
44+
```
45+
46+
2. **Follow the interactive prompts** to:
47+
- Select the type of change (major, minor, patch, or none)
48+
- Provide a clear description of what changed
49+
- The description should explain the feature/fix from a user's perspective
50+
51+
3. **Change types**:
52+
- `major`: Breaking changes that require users to update their code
53+
- `minor`: New features that are backward compatible
54+
- `patch`: Bug fixes and small improvements
55+
- `none`: Internal changes that don't affect the public API
56+
57+
4. **Best practices**:
58+
- Write clear, concise descriptions
59+
- Focus on what changed from the user's perspective
60+
- Include relevant technical details when necessary
61+
- Use present tense ("Add feature X" not "Added feature X")
62+
63+
The change files are automatically generated in `common/changes/@subsquid/[package-name]/` and will be used to generate changelogs during the release process.

‎common/changes/@subsquid/fuel-dump/master_2024-12-20-16-49.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"changes": [
33
{
44
"packageName": "@subsquid/fuel-dump",
5-
"comment": "",
6-
"type": "none"
5+
"comment": "Add block timestamp extraction method for Fuel blocks with TAI64 to Unix timestamp conversion",
6+
"type": "minor"
77
}
88
],
99
"packageName": "@subsquid/fuel-dump"

‎common/changes/@subsquid/fuel-ingest/master_2024-12-20-16-49.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"changes": [
33
{
44
"packageName": "@subsquid/fuel-ingest",
5-
"comment": "",
6-
"type": "none"
5+
"comment": "Add block height and timestamp extraction methods for Fuel ingestion with TAI64 timestamp support",
6+
"type": "minor"
77
}
88
],
99
"packageName": "@subsquid/fuel-ingest"

‎common/changes/@subsquid/solana-dump/master_2024-12-20-16-49.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@subsquid/solana-dump",
5+
"comment": "Add block timestamp extraction method for Solana dumper with Unix timestamp support",
6+
"type": "minor"
7+
}
8+
],
9+
"packageName": "@subsquid/solana-dump"
10+
}

‎common/changes/@subsquid/solana-ingest/master_2024-12-20-16-49.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@subsquid/solana-ingest",
5+
"comment": "Add block height and timestamp extraction methods for Solana ingestion with Unix timestamp support",
6+
"type": "minor"
7+
}
8+
],
9+
"packageName": "@subsquid/solana-ingest"
10+
}

‎common/changes/@subsquid/solana-rpc-data/master_2024-12-20-16-49.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"changes": [
33
{
44
"packageName": "@subsquid/solana-rpc-data",
5-
"comment": "",
6-
"type": "none"
5+
"comment": "Add block timestamp extraction method for Solana blocks with Unix timestamp support",
6+
"type": "minor"
77
}
88
],
99
"packageName": "@subsquid/solana-rpc-data"

‎common/changes/@subsquid/substrate-dump/master_2024-12-20-16-49.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"changes": [
33
{
44
"packageName": "@subsquid/substrate-dump",
5-
"comment": "",
6-
"type": "none"
5+
"comment": "Add block timestamp extraction method for substrate dumper with mocked timestamp implementation",
6+
"type": "minor"
77
}
88
],
99
"packageName": "@subsquid/substrate-dump"

‎common/changes/@subsquid/substrate-ingest/master_2024-12-20-16-49.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@subsquid/substrate-ingest",
5+
"comment": "Add block height and timestamp extraction methods for Substrate ingestion with mocked timestamp implementation",
6+
"type": "minor"
7+
}
8+
],
9+
"packageName": "@subsquid/substrate-ingest"
10+
}

‎common/changes/@subsquid/tron-dump/master_2024-12-20-16-49.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@subsquid/tron-dump",
5+
"comment": "Add block timestamp extraction method for TRON dumper with Unix timestamp support",
6+
"type": "minor"
7+
}
8+
],
9+
"packageName": "@subsquid/tron-dump"
10+
}

‎common/changes/@subsquid/tron-ingest/master_2024-12-20-16-49.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@subsquid/tron-ingest",
5+
"comment": "Add block height and timestamp extraction methods for TRON ingestion with Unix timestamp support",
6+
"type": "minor"
7+
}
8+
],
9+
"packageName": "@subsquid/tron-ingest"
10+
}

0 commit comments

Comments
 (0)