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.

Sign up for GitHub

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

Jump to bottom

Add more detailed PR guides in CONTRIBUTING.md #2435

Merged
merged 7 commits into from
Apr 16, 2023
Merged

Add more detailed PR guides in CONTRIBUTING.md #2435

merged 7 commits into from
Apr 16, 2023

Conversation

AuruTus
Copy link
Contributor

@AuruTus AuruTus commented Apr 15, 2023 •
edited
Loading

Description

Closes #2427 .

Add squash&push guides into CONTRIBUTING.md for better community involvement. And I also add other guides related with PR management which, I think, are also important.

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), Assignee, Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@CLAassistant
Copy link

CLAassistant commented Apr 15, 2023 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@AuruTus AuruTus marked this pull request as ready for review April 15, 2023 02:08
@AuruTus AuruTus requested a review from AlekSi as a code owner April 15, 2023 02:08
@AuruTus
Copy link
Contributor Author

AuruTus commented Apr 15, 2023

Is it a bit long for contributing guides? I only pick some important rules for new contributors, because it seems they cannot access all repo operations. BTW, can reply on next Monday, sorry for my late PR.

@codecov
Copy link

codecov bot commented Apr 15, 2023 •
edited
Loading

Codecov Report

Merging #2435 (d447f33) into main (193c9d4) will decrease coverage by 37.46%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2435       +/-   ##
===========================================
- Coverage   64.39%   26.94%   -37.46%     
===========================================
  Files         392      392               
  Lines       19251    19251               
===========================================
- Hits        12397     5187     -7210     
- Misses       5955    13510     +7555     
+ Partials      899      554      -345

see 125 files with indirect coverage changes

Flag Coverage Δ
integration 4.72% <ø> (-52.66%) ⬇️
mongodb 4.72% <ø> (ø)
pg ?
unit 25.60% <ø> (ø)

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

@AlekSi AlekSi self-assigned this Apr 15, 2023
@AlekSi AlekSi added the documentation Something user-visible is badly or not documented label Apr 15, 2023
@AlekSi AlekSi added this to the v1.1.0 milestone Apr 15, 2023
AlekSi
AlekSi reviewed Apr 15, 2023
View reviewed changes
Copy link
Member

@AlekSi AlekSi left a comment

Choose a reason for hiding this comment

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

Good work, but I think we should move those points rather than copy them to avoid having two separate copies to maintain.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@AuruTus
Copy link
Contributor Author

AuruTus commented Apr 16, 2023

Good work, but I think we should move those points rather than copy them to avoid having two separate copies to maintain.

OK I removed the redundant points in PROCESS.md. I've thought to keep those as a complete working flow.

AlekSi
AlekSi reviewed Apr 16, 2023
View reviewed changes
.github/PROCESS.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/PROCESS.md Show resolved Hide resolved
@AuruTus AuruTus requested a review from AlekSi April 16, 2023 08:12
@AlekSi
Copy link
Member

AlekSi commented Apr 16, 2023

Could you please click a button/link in that comment: #2435 (comment) ?

@AuruTus
Copy link
Contributor Author

AuruTus commented Apr 16, 2023

Could you please click a button/link in that comment: #2435 (comment) ?

OK done with it. I even didn't notice that button before 😅.

@AlekSi AlekSi merged commit 4d47717 into FerretDB:main Apr 16, 2023
@AlekSi
Copy link
Member

AlekSi commented Apr 16, 2023

Thank you!

fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 17, 2023
@AuruTus @fenogentov
Add more detailed PR guides in CONTRIBUTING.md (FerretDB#2435)
14a3a8c 
Closes FerretDB#2427.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AuruTus @fenogentov
Add more detailed PR guides in CONTRIBUTING.md (FerretDB#2435)
7d11780 
Closes FerretDB#2427.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AuruTus @fenogentov
Add more detailed PR guides in CONTRIBUTING.md (FerretDB#2435)
8202f19 
Closes FerretDB#2427.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AuruTus @fenogentov
Add more detailed PR guides in CONTRIBUTING.md (FerretDB#2435)
cd58816 
Closes FerretDB#2427.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlekSi AlekSi AlekSi approved these changes

Assignees

@AlekSi AlekSi

@AuruTus AuruTus

Labels
documentation Something user-visible is badly or not documented
Projects
Current Engineering
Archived in project
Milestone
v1.1.0
Development

Successfully merging this pull request may close these issues.

Document squash&push in contributing guidelines
3 participants
@AuruTus @CLAassistant @AlekSi