Apply class-shadowing.md
to the Spec
#16839
Merged
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.
This is the first PR of porting the Scala 2 Specification (the spec) to include the changes of Scala 3, it aims to serve as an example of what a contribution to the porting of spec should look like
Atomic changes should be contained in commits called
Apply <name>.md
, where<name>.md
is the name of a file contained in one of the subfolders ofTODOreference
, and the content of the commit should be:<name>.md
(in this case
05-classes-and-objects.md
, but could be multiple files)<name>.md
from a subfolder ofTODOreference
to the corresponding subfolder ofAPPLIEDreference
(in this case
class-shadowing.md
)<name>.md
to remove all "spec-y" details, potentially deleting the whole file (e.g. if the only useful content in the file was extracted to the Spec)(in this case
class-shadowing-spec.md
. Note that<name>-spec.md
files should not be deleted just on principle !)Commits that do not adhere to this format are allowed, if they fix something that was already applied
(In the case an important difference with Scala 2 is not present in the reference, it is better to first update the reference, and then change the Spec once that's done)
Please try to obey by the principles outlined in
docs/_spec/README.md
, you'll also find there how to build the spec locally.It is preferable for PRs to contain only one commit.
Tips
Once you make a PR with a single commit, it is easier (also for the reviewer!) to incorporate feedback in temporary commits that you
git squash
just before merging than to constantlygit ammend