Update contributing docs and PR template according to our best practices #779
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rumyantseva
added
the
documentation
Codecov Report
@@ Coverage Diff @@
## main #779 +/- ##
===========================================
- Coverage 59.19% 25.33% -33.87%
===========================================
Files 212 212
Lines 9348 9348
===========================================
- Hits 5534 2368 -3166
- Misses 3169 6617 +3448
+ Partials 645 363 -282
Flags with carried forward coverage won't be shown. Click here to find out more. |
.github/PROCESS.md
Outdated
| Do not leave original commit messages in the squashed commit body. | ||
|
|
||
| ## Draft pull requests | ||
|
|
||
| 1. We aim our issues to be scoped and well-described. |
There was a problem hiding this comment.
Would you please rewrite in active voice?
There was a problem hiding this comment.
Can you suggest the exact sentence? Issues are not actors, so it's hard to come up with active voice for them :) We aim is written in active voice.
There was a problem hiding this comment.
Please see the comment #779 (comment).
I challenge the entire paragraph for its sense, existence, and meaning.
.github/PROCESS.md
Outdated
| With that, ideally, there shouldn't be a need to create a draft pull request. | ||
| 2. We aim to implement and merge improvements as fast as possible to continuously increase | ||
| [Lead Time for Changes](https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance). | ||
| Having too many drafts indicates that something is wrong in our processes, it needs to be discussed and changed. |
There was a problem hiding this comment.
Suggested change
| Having too many drafts indicates that something is wrong in our processes, it needs to be discussed and changed. | |
| Too many drafts indicate that something is wrong in our processes. Then we need to discuss and change it. |
| * [ ] I set assignee, reviewers, labels, milestone, project and sprint. | ||
| * [ ] I added tests for new functionality or bugfixes. | ||
| * [ ] I ran `task all`, and it passed. | ||
| * [ ] I documented exported and unexported functions, variables, types, etc. |
There was a problem hiding this comment.
And I changed the documentation in changed functions correspondingly.
…tseva/FerretDB into issue-749-contributing-ugidelines
w84thesun
reviewed
Jun 23, 2022
rumyantseva
changed the title
rumyantseva
changed the title
…tseva/FerretDB into issue-749-contributing-ugidelines
…tseva/FerretDB into issue-749-contributing-ugidelines
AlekSi
reviewed
Jun 24, 2022
AlekSi
approved these changes
Jun 27, 2022
|
Merging as it is now because we need to move forward with it. We will change those files over time. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR closes #749.
Pull Request Template
The idea is to have a simple Pull Request Template for the community and a more complex one for the team.
After reviewing all the past drafts, I decided not to add all the tiny details from the individual checklist.
I'm not sure if we really need a dedicated template for the team. Please provide feedback about it.
Pull Request Draft
I documented the usage of Pull Request Drafts in PROCESS.md. It is based on our principles and current use cases.
Feel free to disagree and suggest improvements.
How to review
Feel free to rephrase sentences and suggest changes!
Readiness checklist