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

Define how aspects and settings should be named #223

Closed
coala-bot opened this issue Oct 27, 2016 · 7 comments
Closed

Define how aspects and settings should be named #223

coala-bot opened this issue Oct 27, 2016 · 7 comments

Comments

@coala-bot
Copy link

coala-bot commented Oct 27, 2016

This should go into the documentation.

  • An aspect should just talk about a property of something, not qualifying it. Don't name it TooLong but Length
  • Then give it tastes, e.g. Metadata.CommitMessage.Shortlog.Length can have a taste named max_shortlog_length

About tastes:

  • Do not use "allow" or "check", aspects can be turned on or off but tastes 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.

Opened via gitter by @sils

@SiddharthKumar02
Copy link
Member

@sils Should I create a new "Aspects and settings" file in the documentation? Because I can't seem to find a relevant file in the documentation to add these changes

@Techievena
Copy link
Member

@SiddharthKumar02 Are you still working on this issue? 😄

@sils
Copy link
Member

sils commented Mar 13, 2017

unassigning due to inactivity

@EverWinter23
Copy link

So, where should I add this information?

@sils
Copy link
Member

sils commented Mar 20, 2017

I guess putting it on api.coala.io would be good, i.e. in the devdocs of the API

@userzimmermann
Copy link
Member

I changed settings --> tastes in the issue summary and hope that this change will also happen soon to coala/cEPs#67 :)

@Techievena
Copy link
Member

@EverWinter23 Please continue your work on this PR. We really need to have solid definitions of aspects and tastes for removing all kind of discrepancies while implementing aspects in coala.

@coala-bot coala-bot assigned Techievena and unassigned EverWinter23 Apr 21, 2017
Techievena added a commit to Techievena/cEPs that referenced this issue Apr 24, 2017
Definition of how aspects and tastes should be named.

Closes coala/documentation#223
Techievena added a commit to Techievena/cEPs that referenced this issue Apr 29, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena added a commit to Techievena/cEPs that referenced this issue Apr 29, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223

Fix

Fix
Techievena added a commit to Techievena/cEPs that referenced this issue May 1, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena added a commit to Techievena/cEPs that referenced this issue May 1, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena added a commit to Techievena/cEPs that referenced this issue May 4, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena added a commit to Techievena/cEPs that referenced this issue May 7, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena pushed a commit to Techievena/cEPs that referenced this issue May 12, 2017
Techievena added a commit to Techievena/cEPs that referenced this issue May 12, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena pushed a commit to Techievena/cEPs that referenced this issue May 28, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena pushed a commit to Techievena/cEPs that referenced this issue May 31, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena pushed a commit to Techievena/cEPs that referenced this issue Dec 24, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Techievena pushed a commit to Techievena/cEPs that referenced this issue Dec 29, 2017
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
gitmate-bot pushed a commit to Techievena/cEPs that referenced this issue Mar 10, 2018
Description of how aspects and tastes should be named in the future.

Closes coala/documentation#223
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

7 participants