Skip to content

Commit

Permalink
FAQ.rst: Add question "What is a bear anyway?"
Browse files Browse the repository at this point in the history
This adds a brief description on what a bear is.

Closes coala#284
  • Loading branch information
sarthakchakerverty committed Jul 10, 2018
1 parent dae51e4 commit 71c5e48
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Help/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ There are also generic bears, which can be applied language independently on
your code. Their capabilities and information can be seen
`here <https://coala.io/#/languages>`__.

What is a bear anyway?
----------------------

A bear is a routine that is used by coala to check your code
for lint issues. A group of these routines(bears) is used for defining
certain quality requirements in various languages. A bear can analyse code
for potential problems, calculate metrics and even provide corrections for
your code. While many of these bears for various languages are shipped along
with coala, you can easily write some of your own.

How do I get started with coala?
--------------------------------

Expand Down

0 comments on commit 71c5e48

Please sign in to comment.