hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

intellij_coding_guidelines.md: compatibility

Browse Source
This commit is contained in:
Yann Cébron 2022-06-30 14:56:15 +02:00
parent 87693fac42
commit 8e1076f2da
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
topics/basics/intellij_coding_guidelines.md
View File

@ -52,7 +52,7 @@ To avoid unnecessary work when reviewing your changes, please follow these guide
No one likes to leave poor code, but remember that having these changes mixed complicates the process of review.
- Please don't fix multiple problems within a single patch or pull request.
- Please don't commit your changes to configuration files (<path>runConfigurations/IDEA.xml</path>, <path>codeStyleSettings.xml</path>, <path>misc.xml</path>, etc.) unless it is essential for the fix itself.
- Please avoid moving or renaming classes unless it is necessary for the fix.
- Please avoid moving or renaming code unless it is necessary for the fix. Keeping backwards compatibility is critical for the platform.
The ideal pull request would contain one commit with everything needed to fix the bug or implement a feature, but nothing else.
"Commit early, commit often" perfectly applies only to local commits, but such "public commits" are hard to review (the reviewer needs either to go commit by commit spending more time to review work-in-progress, or to review all changes at once thus losing valuable information stored in commit messages).