Improve contributor documentation #4038
Merged
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
armanbilge
reviewed
Mar 9, 2024
CONTRIBUTING.md
Outdated
| When in doubt, just target your work against `series/3.x`. If you're *very* certain that your changes will be source- *and* forward-compatible, it's safe to target the latest major/minor series (e.g. `series/3.4.x`). Note that forward-compatibility means that you cannot *add or remove* an API, while backward-compatibility means you cannot *remove* an API. | ||
|
|
||
| With documentation changes (both Scaladoc and Markdown documentation in `/docs`), target the *earliest* branch to which those changes are relevant. For example, if a method already exists in `series/3.4.x`, documentation about it should also go into `series/3.4.x`. On the other hand, if that method was only added in `series/3.x`, its documentation should go into `series/3.x`. |
There was a problem hiding this comment.
Maybe we need to clarify "earliest maintained branch" or something e.g. do not send changes to series/3.4.x because our current active minor branch is series/3.5.x.
Honestly, we should update this contributing doc every time we release a minor. That will help stave off confusion :)
There was a problem hiding this comment.
Yeah, that makes sense. I did it for the current version.
Co-authored-by: Arman Bilge <armanbilge@gmail.com>
djspiewak
requested changes
Mar 13, 2024
djspiewak
approved these changes
Mar 13, 2024
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.
Hopefully fixes #4005. I don't actually know, how releasing works, this is me trying to understand it.