Fixes #10222: Add guideline for technique naming #289
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
jooooooon
reviewed
Feb 16, 2017
| * Try to keep names as short as possible, to improve readability | ||
| * Read the exinsting technique list, and particularly techniques related to what you are writing. The new names should be consistent with existing ones. | ||
| * The name should be a nominal group. It describes the target of the action, not the action itself. | ||
| * The general name should like like: General Concept (package, file, etc.) + Source (from file, etc.) + Implementation details (platform, software name, etc.) |
| * Read the exinsting technique list, and particularly techniques related to what you are writing. The new names should be consistent with existing ones. | ||
| * The name should be a nominal group. It describes the target of the action, not the action itself. | ||
| * The general name should like like: General Concept (package, file, etc.) + Source (from file, etc.) + Implementation details (platform, software name, etc.) | ||
| * The general idea it to go from the most general information to the most precise. |
|
Commit modified |
amousset
force-pushed
the
ust_10222/add_guideline_for_technique_naming
branch
from
5d6ad89
to
401643c
Compare
jooooooon
reviewed
Feb 16, 2017
| @@ -25,6 +25,18 @@ | |||
|
|
|||
| ==== Writing convention | |||
|
|
|||
| ===== Technique Naming Guidelines | |||
There was a problem hiding this comment.
Just like your guidelines say for technique names, I think this should not be capitalised ;)
| The following rules should be followed when naming a new Technique: | ||
|
|
||
| * Try to keep names as short as possible, to improve readability | ||
| * Read the exinsting technique list, and particularly techniques related to what you are writing. The new names should be consistent with existing ones. |
|
|
||
| * Try to keep names as short as possible, to improve readability | ||
| * Read the exinsting technique list, and particularly techniques related to what you are writing. The new names should be consistent with existing ones. | ||
| * The name should be a nominal group (not "Manage file content" or "Set Service state" but "File content" or "Service state)". It describes the target of the action, not the action itself. |
There was a problem hiding this comment.
Always start with good examples to have bad examples later. Also, the phrasing here doesn't make it very clear what is good or bad.
| * Try to keep names as short as possible, to improve readability | ||
| * Read the exinsting technique list, and particularly techniques related to what you are writing. The new names should be consistent with existing ones. | ||
| * The name should be a nominal group (not "Manage file content" or "Set Service state" but "File content" or "Service state)". It describes the target of the action, not the action itself. | ||
| * The name should look like: General Concept (package, file, etc.) + Source (from file, etc.) + Implementation details (platform, software name, etc.) |
There was a problem hiding this comment.
Examples of this would be useful too. Package repositories may be a good example, or variables?
|
Commit modified |
amousset
force-pushed
the
ust_10222/add_guideline_for_technique_naming
branch
from
401643c
to
351bbfa
Compare
|
👍 |
|
OK, merging this PR |
This pull request was closed.
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.
https://www.rudder-project.org/redmine/issues/10222