Skip to content

Commit 70bd0ef

Browse files
committed
Revert "feat: update changelog and other related files"
This reverts commit fbf203e.
1 parent a7fceb7 commit 70bd0ef

File tree

6 files changed

+53
-47
lines changed

6 files changed

+53
-47
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -103,50 +103,26 @@ Thanks for your contribution!
103103

104104
## Changelog Guidelines
105105

106-
**Every pull request must include a changelog fragment.** This helps users and developers track what has been added, changed, fixed, or removed between versions. The changelog maintains transparency about project evolution and helps users understand the impact of updates.
106+
When contributing to this project, it's important to document your changes in the changelog to help users and developers understand what has been added, changed, fixed, or removed between versions. The changelog helps maintain transparency about project evolution and assists users in understanding the impact of updates. We also have another changelog for design system, so for any design system changes, please include them in that changelog.
107107

108-
We maintain separate changelogs for different components:
108+
### When to Add Changelog Entries
109109

110-
- **Main application changes**: Create fragments in [`docs/release-notes/`](../docs/release-notes/)
111-
- **Design system changes**: For changes affecting design system components, update to [`packages/design-system/CHANGELOG.md`](../packages/design-system/CHANGELOG.md)
112-
113-
### What Needs to Be in the Changelog?
114-
115-
Include developer-visible changes that affect the product, APIs, or workflows:
116-
117-
- **UI changes** (new buttons, wording, layouts)
118-
- **Behavior changes** (URLs, shortcuts, keyboard navigation)
119-
- **Bug fixes** that alter what users experience
120-
- **Performance or accessibility improvements** users benefit from
121-
- **Breaking changes** (anything that requires action to upgrade)
122-
- **Developer-relevant refactors** (if they affect interfaces, tooling, or expected dev workflows)
123-
124-
**All pull requests require a changelog entry.** Document your changes in the appropriate category:
110+
Add a changelog entry for changes, including:
125111

126112
- **Added**: New features, components, or functionality
127113
- **Changed**: Changes to existing functionality, API modifications, or behavior updates
128114
- **Fixed**: Bug fixes and issue resolutions
129115
- **Removed**: Deprecated features or removed functionality
130-
If breaking, prefix with BREAKING: and include a 1-line upgrade note.
131116

132117
### How to Add Changelog Entries
133118

134-
1. **Create a changelog fragment**: Create a new markdown file in `docs/release-notes/` with a descriptive name related to your change and issue number (if applicable)
135-
136-
2. **File naming convention**: Use format like `ISSUE_NUMBER-brief-description.md` or `brief-description.md`
137-
138-
3. **Add your entry**: In the file, add your entry under the appropriate category (`Added`, `Changed`, `Fixed`, or `Removed`)
139-
140-
### Example Changelog Fragments
141-
142-
**Example 1: Documents Addition (Issue #828)**
143-
File: `docs/release-notes/add-changelog.md`
119+
1. **Edit the CHANGELOG.md file**: Add your entry under the `[Unreleased]` section in the appropriate category (`Added`, `Changed`, `Fixed`, or `Removed`)
144120

145-
```markdown
146-
### Added
121+
2. **Follow the format**: Use this structure for entries:
147122

148-
- Add new CHANGELOG.md and its guidance to the repository (#828)
149-
```
123+
```markdown
124+
- Brief description of the change (#ISSUE_NUMBER)
125+
```
150126

151127
## Other ways to contribute to the code
152128

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All notable changes to **Dataverse Frontend** are documented here. We also maintain a separate [Design System Changelog](../../packages/design-system/CHANGELOG.md) for component-specific changes.
3+
All notable changes to **Dataverse Frontend** are documented here. We also maintain a separate [Design System Changelog](./packages/design-system/CHANGELOG.md) for component-specific changes.
44

55
This changelog follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and adheres to [Semantic Versioning](https://semver.org/). This document is intended for developers, contributors, and users who need to understand the technical details.
66

DEVELOPER_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ This project maintains a changelog following the [Keep a Changelog](https://keep
580580
#### When Working on Features
581581
582582
1. **During Development**: Add entries to the `[Unreleased]` section as you implement changes
583-
2. **Before PR Submission**: PR should include a changelog fragment if it should be included
583+
2. **Before PR Submission**: Ensure all user-facing changes have appropriate changelog entries
584584
3. **PR Review**: Reviewers will verify changelog entries are complete and properly formatted
585585
586586
#### Changelog Entry Guidelines

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,11 +282,11 @@ For more information on the Dataverse re-architecture project, see the original
282282

283283
## Changelog
284284

285-
All notable changes to this project are documented in our [CHANGELOG.md](docs/release-notes/CHANGELOG.md). The changelog follows the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format and adheres to [Semantic Versioning](https://semver.org/).
285+
All notable changes to this project are documented in our [CHANGELOG.md](CHANGELOG.md). The changelog follows the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format and adheres to [Semantic Versioning](https://semver.org/).
286286

287287
We also maintain a separate [Design System Changelog](./packages/design-system/CHANGELOG.md) for component-specific changes.
288288

289-
**For Contributors**: **Every pull request must include a changelog entry.** See our [Changelog Guidelines](.github/CONTRIBUTING.md#changelog-guidelines) for details on format and requirements.
289+
**For Contributors**: Please ensure you add appropriate changelog entries for user-facing changes when submitting pull requests. See our [Changelog Guidelines](.github/CONTRIBUTING.md#changelog-guidelines) for details.
290290

291291
<p align="right">(<a href="#readme-top">back to top</a>)</p>
292292
<br>

docs/making-releases.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,49 @@ npm version 3.5.0 --no-git-tag-version
4040

4141
This command will update the version in the `package.json` and `package-lock.json`.
4242

43-
## Consolidate Changelog Fragments
43+
## Update the Changelog
4444

45-
Before releasing, consolidate all changelog fragments into the main changelog:
45+
Before releasing, ensure the changelog is properly prepared:
4646

47-
1. **Collect all fragments** from [`docs/release-notes/`](../docs/release-notes/) directory (all `.md` files)
48-
2. **Group entries by category** from all fragments (`Added`, `Changed`, `Fixed`, `Removed`)
49-
3. **Create the release section** in the main changelog [`docs/release-notes/CHANGELOG`](../docs/release-notes/CHANGELOG.md) by consolidating all fragment entries
50-
4. **Clear the fragment directory** - Delete all processed fragment files after consolidation
51-
5. **Update version links** at the bottom of the changelog file
52-
6. **Commit the changelog updates** as part of the release preparation
47+
1. **Review the [Unreleased] section** in `CHANGELOG.md` and `packages/design-system/CHANGELOG.md`
48+
2. **Move entries from [Unreleased] to the new version section**:
49+
50+
```markdown
51+
## [vX.X.X] -- YYYY-MM-DD
52+
53+
### Added
54+
55+
- Feature descriptions from unreleased section
56+
57+
### Changed
58+
59+
- Changes from unreleased section
60+
61+
### Fixed
62+
63+
- Bug fixes from unreleased section
64+
65+
### Removed
66+
67+
- Removals from unreleased section
68+
```
69+
70+
3. **Clear the [Unreleased] section** but keep the structure:
71+
72+
```markdown
73+
## [Unreleased]
74+
75+
### Added
76+
77+
### Changed
78+
79+
### Fixed
80+
81+
### Removed
82+
```
83+
84+
4. **Update the version links** at the bottom of the changelog files
85+
5. **Commit the changelog updates** as part of the release preparation
5386

5487
## Use the Latest Dataverse Client Javascript Version
5588

docs/release-notes/add-changelog.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)