-
Notifications
You must be signed in to change notification settings - Fork 53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
cEP-0005.md: Defines way to name aspects and settings #67
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -124,6 +124,15 @@ class RedundancyBear(LocalBear): | |
yield Result.from_values(aspect=aspect, ...) | ||
``` | ||
|
||
## Aspects | ||
An aspect should just talk about a property of something, not qualifying it. Don't name it TooLong but Length. | ||
Then give it settings, e.g. Metadata.CommitMessage.Shortlog.Length can have a setting max_shortlog_length. | ||
|
||
## Settings | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think its better we have definition of tastes instead of settings. Moreover which issue is this related to? Have a proper commit message. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @EverWinter23 As @Techievena mentioned it's really important to rename settings to tastes, since the latter is the new official term. |
||
Do not use "allow" or "check", aspects can be turned on or off but Settings should change behaviour. | ||
For bool: use "shortlog_colon" if it must have a colon in the shortlog. Describe the thing that should be true: "shortlog_starts_upper_case". Give as much context as needed but not more. | ||
|
||
|
||
The concept of aspects allows us to implement a consistency check and reduce | ||
documentation redundancy. Instead of documenting settings and results in every | ||
bear, we can create a new aspects class. A working implementation of the | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please keep the terms aspect and aspects lower case according to #69