Add contribution process description #1827
Open
+9
−0
Conversation
This file contains hidden or 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
Metadorius
added
❓Project policy
Minor
|
Nightly build for this pull request:
This comment is automatic and is meant to allow guests to get latest nightly builds for this pull request without registering. It is updated on every successful build. |
ZivDero
requested changes
Aug 21, 2025
Co-authored-by: Kirill Andriiashin <[email protected]>
Metadorius
commented
Aug 21, 2025
Metadorius
commented
Aug 21, 2025
There was a problem hiding this comment.
Is this process description a 'requirement' or a 'guide'? I see that the content here, such as the repeated use of should seems more mandatory. If it is the latter, then splitting it more detailedly and explaining why each step is important would be more effective. Similarly, I think To ensure your contribution is smoothly accepted, please follow the following process: is more effective for new contributors than should try to stick to.
|
|
||
| Generally, we should try to stick to the following process when contributing to the project: | ||
| 1. Check whether there is an open pull request for whatever you want to contribute. If there is - comment on it and see if you can help with it instead of starting your own first. We hate to discard otherwise valid work just because it's a duplicate. | ||
| 2. If all is clear - you should **get in touch with maintainers** of level high enough to review/merge your future PR and __talk with them about key design aspects before you even submit a contribution__. This is *especially* important for bigger and more fundamental improvements, when you're learning and when you're exploring "uncharted territories". Staying engaged in communication with the maintainers will help you to avoid unnecessary reworks later on and make sure that your contribution is aligned with how we do things. Not only that, but it also allows you to essentially get early reviews on important things and faster merges (which is especially important in light of our large amount of PRs) with higher level of confidence. |
There was a problem hiding this comment.
- Here,
your future PRseems ambiguous; perhaps it should be something likeyour upcoming PR? - I see there is
__bold__writing here; why not use a consistent format? maintainers of level high enoughneeds a more accurate description, such asT? Maintainers or Leads.- I think this paragraph is a bit too long, visually very dense and the key points are not concentrated. If it is split according to the content, it should be more helpful for reading, unless we have a detailed flowchart here.
| ### Contribution process | ||
|
|
||
| Generally, we should try to stick to the following process when contributing to the project: | ||
| 1. Check whether there is an open pull request for whatever you want to contribute. If there is - comment on it and see if you can help with it instead of starting your own first. We hate to discard otherwise valid work just because it's a duplicate. |
There was a problem hiding this comment.
For the first mention and non-abbreviated form, Pull Request might be more suitable to have the first letter capitalized.
DeathFishAtEase
added
the
No Documentation Needed
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.
No description provided.