Skip to content

Docs/restructure readme #1989

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

Merged
merged 6 commits into from
Dec 14, 2023
Merged

Docs/restructure readme #1989

merged 6 commits into from
Dec 14, 2023

Conversation

seyfeb
Copy link
Collaborator

@seyfeb seyfeb commented Dec 14, 2023

Topic and Scope

Restructure the README file

  • Rearrange sections
  • Move clients to separate file
  • Fix missing CI badge

Concerns/issues

None

Formal requirements

There are some formal requirements that should be satisfied. Please mark those by checking the corresponding box.

  • I did check that the app can still be opened and does not throw any browser logs
  • I created tests for newly added PHP code (check this if no PHP changes were made)
  • I updated the OpenAPI specs and added an entry to the API changelog (check if API was not modified)
  • I notified the matrix channel if I introduced an API change

…down. Make warning more prominent with new github alert box.

Signed-off-by: Sebastian Fey <[email protected]>
Signed-off-by: Sebastian Fey <[email protected]>
Signed-off-by: Sebastian Fey <[email protected]>
Signed-off-by: Sebastian Fey <[email protected]>
Copy link

github-actions bot commented Dec 14, 2023

Test Results

     12 files     572 suites   1m 30s ⏱️
   552 tests    552 ✔️ 0 💤 0
2 208 runs  2 207 ✔️ 1 💤 0

Results for commit 48f5d50.

♻️ This comment has been updated with latest results.

Copy link

codecov bot commented Dec 14, 2023

Codecov Report

Merging #1989 (48f5d50) into master (feb842f) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1989   +/-   ##
=======================================
  Coverage   80.07%   80.07%           
=======================================
  Files          92       92           
  Lines        2650     2650           
=======================================
  Hits         2122     2122           
  Misses        528      528           
Flag Coverage Δ
integration 21.43% <ø> (ø)
migration 5.69% <ø> (ø)
unittests 57.09% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Collaborator

@christianlupus christianlupus left a comment

Choose a reason for hiding this comment

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

Lgtm

@christianlupus christianlupus merged commit 9ad01b6 into master Dec 14, 2023
@christianlupus christianlupus deleted the docs/restructure-readme branch December 14, 2023 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants