Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
c6545051
Unverified
Commit
c6545051
authored
4 years ago
by
colemanw
Committed by
GitHub
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Clarify (NFC) tag on PRs
parent
b33a68ee
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/tools/git.md
+6
-4
6 additions, 4 deletions
docs/tools/git.md
with
6 additions
and
4 deletions
docs/tools/git.md
+
6
−
4
View file @
c6545051
...
...
@@ -124,17 +124,19 @@ Here are some examples and counter-examples of NFC:
*
Modify whitespace in PHP code.
*
Update a code comment.
*
Fix a typo or grammatical error in a help dialog.
*
(
*Maybe*
) Add a new unit-test where there was no coverage before.
*
(
*Maybe*
) Add a new unit-test where there was no coverage before (see below).
*
(
*Maybe*
) Update a PHP doc block (see below).
*
_Functional Change_:
*
Refactoring
*
Replace 20 lines of redundant code with a call to a helper function.
*
Refactoring, e.g. replacing 20 lines of redundant code with a call to a helper function.
*
(__Why?__ A reviewer would consider whether the helper is truly equivalent, better, or worse.)
*
Fix a typo in a
*symbol*
(PHP class-name, PHP function-name, HTML field name, etc).
*
(__Why?__ A reviewer would consider dangling references to the symbol.)
*
Change the general wording of a help dialog or menu item.
*
(__Why?__ A reviewer would consider impact on the user's comprehension.)
*
A
lter the substance of
an existing unit-test.
*
A
dd or alter
an existing unit-test.
*
(__Why?__ A reviewer would consider whether the change improves the correctness of the test.)
*
Update annotations in a PHP doc block.
*
(__Why?__ Some annotations affect functionality, e.g. the
`@required`
annotation on an APIv4 param.)
*
Alter the build process.
*
(__Why?__ A reviewer would consider whether the new build will work correctly.)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment