Skip to content
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

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions cEP-0005.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,15 @@ class RedundancyBear(LocalBear):
yield Result.from_values(aspect=aspect, ...)
```

## Aspects
Copy link
Member

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

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
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Member

Choose a reason for hiding this comment

The 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
Expand Down