cEP5: Define bear picking strategy and ambiguity on configuration #78

adhikasp · 2017-05-12T15:14:50Z

@coala/aspects-developers

gitmate-bot · 2017-05-12T15:15:15Z

cEP-0005.md

@@ -3,7 +3,7 @@
 | Metadata     |                                               |
 | ------------ |-----------------------------------------------|
 | cEP          | 5                                             |
-| Version      | 2.0                                           |
+| Version      | 2.1                                           |
 | Title        | coala Configuration                           |
 | Authors      | Lasse Schuirmann <[email protected]> |


Line contains following spacing inconsistencies:

Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section spacing.

The issue can be fixed by applying the following patch:

--- a/cEP-0005.md +++ b/cEP-0005.md @@ -88,7 +88,7 @@ aspect name could be writen by its fullname (`Root.Redundancy.Clone`) or partial name (`Redundancy.Clone` or even `Clone`) and are case insensitive. Note that writing by partial name could result in ambiguity. Thus the desired -aspect must be written by its fullname. +aspect must be written by its fullname. In case of multiple aspect has a same taste name, ambiguity will be resolved by prefixing the taste name with its aspect name. For example, `max_length`

jayvdb

The bear picking strategy should emit a log entry explaining the choice it made, and which bears were not used.

userzimmermann

@adhikasp This is really nice :) Especially the prioritization! But there are some drawbacks in the texts...

userzimmermann · 2017-05-26T19:14:29Z

cEP-0005.md

@@ -85,6 +85,16 @@ files = **.(c|h)
 ignore_aspects = redundancy  # Exclusive
 ```

+aspect name could be writen by its fullname (`Root.Redundancy.Clone`) or
+partial name (`Redundancy.Clone` or even `Clone`) and are case insensitive.


You start in singular (name, its) but end in plural (are)

Instead of fullname better write fully qualified name

Instead of partial name better write partially qualified name to avoid any misunderstandings

Better use can instead of could

Sorry, grammar is never my best thing 😖

userzimmermann · 2017-05-26T19:16:05Z

cEP-0005.md

+aspect name could be writen by its fullname (`Root.Redundancy.Clone`) or
+partial name (`Redundancy.Clone` or even `Clone`) and are case insensitive.
+Note that writing by partial name could result in ambiguity. Thus the desired
+aspect must be written by its fullname.


You don't need to necessarily use the fully qualified name in that case. It must only be enough qualified to remove the ambiguity

Oh yeah, right

userzimmermann · 2017-05-26T22:22:12Z

cEP-0005.md

+In case of multiple aspect has a same taste name, ambiguity will be resolved
+by prefixing the taste name with its aspect name. For example, `max_length`
+is a taste under `Shortlog` and `LineLength`. Thus defining the taste must
+be written by `Shortlog.max_length = 50`.


multiple aspects have ...

is a taste of ...

Thus the Shortlog taste would be defined like ...

userzimmermann · 2017-05-26T22:26:37Z

Also, I agree with @jayvdb's #78 (review)

adhikasp · 2017-05-29T11:48:41Z

@jayvdb

The bear picking strategy should emit a log entry explaining the choice it made, and which bears were not used.

Why we should tell which bears is not used, instead of just bear that is used?

userzimmermann · 2017-05-30T15:05:36Z

@adhikasp Perfect 🎉 We only have to wait for @Techievena to rebase #72 , so that you can then rebase on his merged commit

And @jayvdb please approve as well :)

userzimmermann · 2017-05-30T15:13:59Z

@adhikasp According to what I've written in https://gitlab.com/coala/GSoC-2017/issues/139#note_31058470 : Let's maybe better not wait for @Techievena to rebase #72 ... Just to hurry up regarding GSoC

meetmangukiya · 2017-05-30T15:18:10Z

cEP-0005.md

@@ -3,7 +3,7 @@
 | Metadata     |                                               |
 | ------------ |-----------------------------------------------|
 | cEP          | 5                                             |
-| Version      | 2.0                                           |
+| Version      | 2.1                                           |
 | Title        | coala Configuration                           |
 | Authors      | Lasse Schuirmann <[email protected]> |


add yourself as author

jayvdb · 2017-05-30T15:27:26Z

cEP-0005.md

@@ -85,6 +85,18 @@ files = **.(c|h)
 ignore_aspects = redundancy  # Exclusive
 ```

+aspect name could be writen by its fully qualified name


Per #69 (comment) and prior comments, the cEP should not be forced to use lowercase aspects instead of using proper grammar, which is capitalised "Aspects" at the beginning of a sentence.

So, either use "Aspects" here, or adjust the sentence so that the word "aspects" is not the start of the sentence.

@adhikasp @jayvdb #72 (comment)

Relates to https://gitlab.com/coala/GSoC-2017/issues/139

jayvdb · 2017-05-30T16:00:24Z

ack d637e1c

jayvdb · 2017-05-30T16:00:36Z

@rultor merge

rultor · 2017-05-30T16:01:32Z

@rultor merge

@jayvdb OK, I'll try to merge now. You can check the progress of the merge here

rultor · 2017-05-30T16:03:36Z

@rultor merge

@jayvdb Done! FYI, the full log is here (took me 2min)

gitmate-bot added process/pending review size/S labels May 12, 2017

gitmate-bot reviewed May 12, 2017

View reviewed changes

adhikasp force-pushed the adhikasp/cEP5-gsoc branch from f91cded to b09dcbb Compare May 12, 2017 15:28

jayvdb requested changes May 26, 2017

View reviewed changes

jayvdb requested a review from userzimmermann May 26, 2017 18:35

userzimmermann requested changes May 26, 2017

View reviewed changes

adhikasp force-pushed the adhikasp/cEP5-gsoc branch from b09dcbb to fc91251 Compare May 29, 2017 14:45

userzimmermann approved these changes May 30, 2017

View reviewed changes

meetmangukiya reviewed May 30, 2017

View reviewed changes

jayvdb requested changes May 30, 2017

View reviewed changes

adhikasp added 2 commits May 30, 2017 22:49

cEP-0005.md: Define bear picking strategy

c443a9e

Relates to https://gitlab.com/coala/GSoC-2017/issues/139

cEP-0005.md: Resolve ambiguity on configuration

d637e1c

Relates to https://gitlab.com/coala/GSoC-2017/issues/139

adhikasp force-pushed the adhikasp/cEP5-gsoc branch from fc91251 to d637e1c Compare May 30, 2017 15:50

jayvdb approved these changes May 30, 2017

View reviewed changes

rultor merged commit d637e1c into coala:master May 30, 2017

userzimmermann added the enhancement label Jun 6, 2017

userzimmermann assigned adhikasp Jun 6, 2017

userzimmermann added this to the #aspectsYEAH milestone Jun 6, 2017

gitmate-bot added the status/STALE label Dec 20, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cEP5: Define bear picking strategy and ambiguity on configuration #78

cEP5: Define bear picking strategy and ambiguity on configuration #78

adhikasp commented May 12, 2017

gitmate-bot May 12, 2017

jayvdb left a comment

userzimmermann left a comment

userzimmermann May 26, 2017

adhikasp May 29, 2017

userzimmermann May 26, 2017

adhikasp May 29, 2017

userzimmermann May 26, 2017

userzimmermann commented May 26, 2017

adhikasp commented May 29, 2017

userzimmermann commented May 30, 2017 •

edited

Loading

userzimmermann commented May 30, 2017

meetmangukiya May 30, 2017

jayvdb May 30, 2017

userzimmermann May 30, 2017 •

edited

Loading

jayvdb commented May 30, 2017

jayvdb commented May 30, 2017

rultor commented May 30, 2017

rultor commented May 30, 2017

cEP5: Define bear picking strategy and ambiguity on configuration #78

cEP5: Define bear picking strategy and ambiguity on configuration #78

Conversation

adhikasp commented May 12, 2017

Choose a reason for hiding this comment

jayvdb left a comment

Choose a reason for hiding this comment

userzimmermann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

userzimmermann commented May 26, 2017

adhikasp commented May 29, 2017

userzimmermann commented May 30, 2017 • edited Loading

userzimmermann commented May 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

userzimmermann May 30, 2017 • edited Loading

Choose a reason for hiding this comment

jayvdb commented May 30, 2017

jayvdb commented May 30, 2017

rultor commented May 30, 2017

rultor commented May 30, 2017

userzimmermann commented May 30, 2017 •

edited

Loading

userzimmermann May 30, 2017 •

edited

Loading