Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix IndexedDBStore API documentation #3987

Merged
merged 2 commits into from
Jan 25, 2024
Merged

Conversation

WebFreak001
Copy link
Contributor

@WebFreak001 WebFreak001 commented Jan 5, 2024

Retroactively changes the changelog entry to include since when this change is needed as well, so that other people upgrading the SDK can more easily find what to change.

Fix #3986

Only documentation & error strings have changed so I have not adjusted any tests. A proper integration test would probably be nice, but I didn't have the time to look into how that is setup on this project.


This change is marked as an internal change (Task), so will not be included in the changelog.

Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

CHANGELOG.md Outdated Show resolved Hide resolved
@richvdh richvdh added the T-Task Tasks for the team like planning label Jan 24, 2024
@WebFreak001
Copy link
Contributor Author

um it looks like the changelog diff broke just now when I used the github edit feature - is there inconsistent line endings in the file causing the web editor diff to break?

@richvdh
Copy link
Member

richvdh commented Jan 24, 2024

um it looks like the changelog diff broke just now when I used the github edit feature - is there inconsistent line endings in the file causing the web editor diff to break?

possibly. Not sure, I'm afraid

@WebFreak001
Copy link
Contributor Author

WebFreak001 commented Jan 24, 2024

I just removed the changelog entry now, seems to be too much of a hassle to get the line endings right with git (also there doesn't seem to be a "unreleased" version where I would need to put the new entry for the upcoming version)

@richvdh
Copy link
Member

richvdh commented Jan 24, 2024

I just removed the changelog entry now, seems to be too much of a hassle to get the line endings right with git

Wasn't the whole point of this PR to update the changelog?

(also there doesn't seem to be a "unreleased" version where I would need to put the new entry for the upcoming version)

Take a look at the contributing doc. The changelog is autogenerated.

@WebFreak001
Copy link
Contributor Author

ah you are right sorry, I forgot what I actually did in this PR - I readded the changelog entry to the version where I put it earlier in the PR

Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! A couple of final things, I'm afraid.

  • It's failing CI due to a failure from the linter. It's probably complaining about line length, though I haven't checked in detail. Please either see what the matter with it is or run the changes through prettier.
  • We require sign-off for all changes, even ones as simple as this. Sorry! Please take a look at https://github.com/element-hq/element-web/blob/develop/CONTRIBUTING.md#sign-off and if you are happy, add a "Signed-off-by" line to the PR description.

@WebFreak001
Copy link
Contributor Author

ok should be good now

@richvdh
Copy link
Member

richvdh commented Jan 24, 2024

Sorry, but as the contributing guide says, I'm afraid we don't accept contributions signed off under a pseudonym, so we'll need your real name to be able to accept this. See https://github.com/element-hq/element-web/blob/develop/CONTRIBUTING.md#private-sign-off.

changes the changelog entry to include since when this change is needed

fix matrix-org#3986

Signed-off-by: Jan Jurzitza <[email protected]>
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your patience!

@richvdh richvdh enabled auto-merge January 25, 2024 09:42
@richvdh richvdh added this pull request to the merge queue Jan 25, 2024
Merged via the queue into matrix-org:develop with commit 5bf29ef Jan 25, 2024
20 checks passed
@WebFreak001 WebFreak001 deleted the fix-3986 branch January 26, 2024 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Task Tasks for the team like planning Z-Community-PR Issue is solved by a community member's PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IndexedDBStore: createUser is undefined, it should be set with setUserCreator when upgrading 29.1.0 -> 30.3.0
2 participants