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

Add more documentation-related items to definition of done #2494

Merged
merged 5 commits into from Apr 24, 2023

Conversation

rumyantseva
Copy link
Member

@rumyantseva rumyantseva commented Apr 21, 2023

Description

As discussed with @Fashander, if some user documentation needs to be written after a task implementation, it might make sense to create a separate issue about it. In this issue, we can mention the important details that need to be documented, so Alex has some input to write user docs.

Mark as "do not merge" so everyone can take a look.

Readiness checklist

  • I added/updated unit tests.
  • I added/updated integration/compatibility tests.
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@rumyantseva rumyantseva added the code/chore Code maintenance improvements label Apr 21, 2023
@rumyantseva rumyantseva self-assigned this Apr 21, 2023
@rumyantseva rumyantseva added the do not merge PRs that should not be merged label Apr 21, 2023
@rumyantseva rumyantseva marked this pull request as ready for review April 21, 2023 07:46
@rumyantseva rumyantseva enabled auto-merge (squash) April 21, 2023 07:46
@codecov
Copy link

codecov bot commented Apr 21, 2023

Codecov Report

Merging #2494 (8dba338) into main (2c858f6) will increase coverage by 38.02%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2494       +/-   ##
===========================================
+ Coverage   26.74%   64.76%   +38.02%     
===========================================
  Files         399      399               
  Lines       19740    19740               
===========================================
+ Hits         5279    12785     +7506     
+ Misses      13902     6039     -7863     
- Partials      559      916      +357     

see 128 files with indirect coverage changes

Flag Coverage Δ
integration 57.96% <ø> (+52.84%) ⬆️
mongodb 5.12% <ø> (ø)
pg 57.89% <ø> (?)
unit 25.35% <ø> (+0.02%) ⬆️

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

Co-authored-by: Alexey Palazhchenko <alexey.palazhchenko@gmail.com>
Copy link
Contributor

@w84thesun w84thesun left a comment

Choose a reason for hiding this comment

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

👍

@rumyantseva rumyantseva requested a review from AlekSi April 21, 2023 12:24
@rumyantseva rumyantseva removed the do not merge PRs that should not be merged label Apr 24, 2023
@rumyantseva rumyantseva merged commit e44c4d3 into FerretDB:main Apr 24, 2023
34 of 36 checks passed
@rumyantseva rumyantseva deleted the dod-docs-issue branch April 24, 2023 10:21
@AlekSi AlekSi added this to the v1.1.0 milestone May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code/chore Code maintenance improvements
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

6 participants