-
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
Conversation
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 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.
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.
@EverWinter23 As @Techievena mentioned it's really important to rename settings to tastes, since the latter is the new official term.
Squash the commits |
Done |
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.
No commit message body , please read how to wright good commit messages.
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.
Using bulleted list will make it better. Apply bulleted list for Aspects and Settings.
eg This "Then give it settings, e.g. Metadata.CommitMessage.Shortlog.Length can have a setting max_shortlog_length." is not reflected on a new line.
-item1
-item2
will be reflected as
- item1
- item2
@yashtrivedi96 is there any place where we can check these cool things about bulleted list showing and etc as my 1 doc issue is still floating.It would be very helpful. |
That is for rst |
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.
settings --> tastes
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 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.
will make the changes |
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.
#69 :)
@@ -124,6 +124,15 @@ class RedundancyBear(LocalBear): | |||
yield Result.from_values(aspect=aspect, ...) | |||
``` | |||
|
|||
## Aspects |
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
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
@EverWinter23 Still working on this or want someone else to take over? :) |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
2 similar comments
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
5 similar comments
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again! |
@EverWinter23 Closing this in favor of #72 , which is based on your PR! Thanks for your work :) |
Closes coala/documentation#223.