-
Notifications
You must be signed in to change notification settings - Fork 12
Coala #28
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
base: master
Are you sure you want to change the base?
Coala #28
Conversation
hello anybody? |
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.
@darthgera123 Nice work, just a few minor changes requested :) Ping me here once addressed.
|
||
This is a guide on how to use coala-bears for this project | ||
|
||
This project consists of a .coafile which basically has all the guidelines |
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.
.coafile should be in codespace like .coafile
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.
.coafile is there in the codespace. This is just the documentation
This is a guide on how to use coala-bears for this project | ||
|
||
This project consists of a .coafile which basically has all the guidelines | ||
that needs to be followed when working with coala.It can modified. |
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.
missing a space, "coala. It can..."
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.
And it should it with working with coala or working with wtfpython-web?
This project consists of a .coafile which basically has all the guidelines | ||
that needs to be followed when working with coala.It can modified. | ||
|
||
In order to specify the files to analyze, you can use the --files argument. |
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.
code highlight --files
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.
btw we don't need --files
argument
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.
you just need to run coala, and since .coafile
is already present, settings would be supplied from there.
So instead of this section, you should add instructions to install coala using pip, and use it inside the project directory!
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.
okay will do
You can also run coala in non interactive mode | ||
`coala --non-interactive` | ||
|
||
###Auto-applying results |
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.
Instead of asking user to supply the flags, you can add default_actions
in the .coafile.
Example: https://github.com/coala/coala-quickstart/blob/master/.coafile#L25
So adding this default section to the all
section should do the job for us!
`coala --non-interactive` | ||
|
||
###Auto-applying results | ||
Coala includes a special setting called default_actions that allows you to set the |
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.
All this would no longer be needed one we add default action. We just need the instructions to install and run coala, that's all.
All the other changes should be made to .coafile
which the other developers on wtfpython-web
need not to worry about.
@darthgera123 please squash your commits and update the issue description to make it more informative. |
NOTE:
Please fill out the template below
[. ] Did you read the instructions in the WORKFLOW ?
[. ] Is your Python code styled according to the PEP8 code style convention as mentioned here ?
[. ] Have you run the tests ?
[. ] Have you followed commit guidelines as mentioned here ?
This adds the coafile and a small guide to working with coala and solves issue Set up static code analysis #12