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

Improve documentation for all bears #332

Open
sils opened this issue Apr 21, 2016 · 5 comments
Open

Improve documentation for all bears #332

sils opened this issue Apr 21, 2016 · 5 comments

Comments

@sils
Copy link
Member

sils commented Apr 21, 2016

It'd be super awesome to have someone going through all bears and improve their documentation such that:

  • It is clear what the bear does without looking up anything on top on the internet.
  • All results clearly point out what's wrong and ideally have the additional_info field set with a long description about it.
  • All offered features are easily accessible.
  • No linter specific config file must be written in order to use the bears.

Would be good if some more experienced contributor does this, shouldn't take too much of time per bear if you know your way around this stuff it's just a lot of bears.

Feel free to file sub issues.

@gitmate-bot
Copy link
Collaborator

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

@sils
Copy link
Member Author

sils commented Apr 21, 2016

if a bear is completely revamped and got merged that may be indicated at https://docs.google.com/spreadsheets/d/1ZJTe1nFsWuKxVdRgHOlpKNI1cLHb4QgY7aAq9tOaa9w/edit#gid=0

@sils
Copy link
Member Author

sils commented Apr 22, 2016

They should also all have the LANGUAGES attribute set! coala understands that now.

@sils
Copy link
Member Author

sils commented Apr 22, 2016

See also #340 for other stuff that should happen.

@sils sils modified the milestones: Make Bears Great, 0.2 Apr 22, 2016
@sils
Copy link
Member Author

sils commented Apr 25, 2016

FWIW I did a hell lot of doc improvement on linter bears that were migrated to the new linter, this issue should be doable for the release.

@AbdealiLoKo AbdealiLoKo removed their assignment Sep 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants