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

Documentation for contributors #1194

Merged
merged 5 commits into from
Oct 5, 2022

Conversation

Fashander
Copy link
Member

Description

This PR closes #1164 .

Readiness checklist

  • I added tests for new functionality or bugfixes.
  • I ran task all, and it passed.
  • I added/updated comments for both exported and unexported top-level declarations (functions, types, etc).
  • I checked comments rendering with task godocs.
  • I ensured that the title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Assignee, Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@Fashander Fashander added the documentation Something user-visible is badly or not documented label Sep 29, 2022
@Fashander Fashander requested review from a team and AlekSi September 29, 2022 12:35
@vercel
Copy link

vercel bot commented Sep 29, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
ferret-db ✅ Ready (Inspect) Visit Preview Oct 5, 2022 at 10:55AM (UTC)

@CLAassistant
Copy link

CLAassistant commented Sep 29, 2022

CLA assistant check
All committers have signed the CLA.

@vercel vercel bot temporarily deployed to Preview September 29, 2022 12:36 Inactive
website/docs/contributing.md Outdated Show resolved Hide resolved
website/docs/contributing.md Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview September 29, 2022 16:22 Inactive
@codecov
Copy link

codecov bot commented Sep 29, 2022

Codecov Report

Merging #1194 (cd8ed00) into main (14c042a) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1194   +/-   ##
=======================================
  Coverage   66.45%   66.45%           
=======================================
  Files         252      252           
  Lines       12331    12331           
=======================================
+ Hits         8194     8195    +1     
+ Misses       3244     3243    -1     
  Partials      893      893           
Impacted Files Coverage Δ
internal/util/version/version.go 55.00% <0.00%> (-5.00%) ⬇️
internal/handlers/common/filter.go 86.58% <0.00%> (ø)
internal/handlers/tigris/msg_listdatabases.go 50.70% <0.00%> (+5.63%) ⬆️
Flag Coverage Δ
integration 62.73% <ø> (+<0.01%) ⬆️
mongodb 14.80% <ø> (-0.03%) ⬇️
pg 51.84% <ø> (-0.03%) ⬇️
tigris 34.89% <ø> (+<0.01%) ⬆️
unit 23.83% <ø> (-0.29%) ⬇️

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

noisersup
noisersup previously approved these changes Sep 29, 2022
@noisersup noisersup self-requested a review September 29, 2022 16:30
@Fashander Fashander force-pushed the documentation-for-contributors-1164 branch from 6ffa2f7 to 9140e74 Compare September 30, 2022 18:26
@vercel vercel bot temporarily deployed to Preview September 30, 2022 18:28 Inactive
@AlekSi AlekSi requested review from a team, rumyantseva and w84thesun and removed request for a team October 3, 2022 06:09
website/docs/contributing.md Outdated Show resolved Hide resolved
website/docs/contributing.md Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview October 3, 2022 11:24 Inactive
@Fashander Fashander requested a review from AlekSi October 3, 2022 11:27
@Fashander Fashander requested a review from AlekSi October 4, 2022 09:06
@vercel vercel bot temporarily deployed to Preview October 4, 2022 09:06 Inactive
w84thesun
w84thesun previously approved these changes Oct 5, 2022
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.

LGTM

Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

LGTM overall, a couple of suggestions (feel free to reject).

website/docs/contributing.md Outdated Show resolved Hide resolved
website/docs/contributing.md Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview October 5, 2022 09:25 Inactive
website/docs/contributing.md Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview October 5, 2022 10:04 Inactive
@vercel vercel bot temporarily deployed to Preview October 5, 2022 10:07 Inactive
@vercel vercel bot temporarily deployed to Preview October 5, 2022 10:10 Inactive
@Fashander Fashander force-pushed the documentation-for-contributors-1164 branch from 09b43fa to e421ec6 Compare October 5, 2022 10:34
@vercel vercel bot temporarily deployed to Preview October 5, 2022 10:38 Inactive
@vercel vercel bot temporarily deployed to Preview October 5, 2022 10:55 Inactive
Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

LGTM

@AlekSi AlekSi enabled auto-merge (squash) October 5, 2022 16:14
@AlekSi AlekSi added this to the v0.6.0 Alpha milestone Oct 5, 2022
@AlekSi AlekSi merged commit 6677714 into FerretDB:main Oct 5, 2022
@Fashander Fashander deleted the documentation-for-contributors-1164 branch October 27, 2022 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something user-visible is badly or not documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for contributors
6 participants