documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Update the Getting Started tutorial

Open nityeshaga opened this issue 7 years ago • 7 comments

Quite a lot of changes were made to the coala CLI in this GSOC 2017 project. These include but are probably not limited to:

  • Use letters instead of numbers for selecting actions.
  • 2 new courses of action when one the bears find a problem in the code-
    • Show Applied (P)atches
    • (G)enerate patches

Thus, the Getting Started tutorial should be updated reflecting these changes.

nityeshaga avatar Feb 15 '18 18:02 nityeshaga

cc @yukiisbored @Adrianzatreanu

nityeshaga avatar Feb 15 '18 18:02 nityeshaga

I would like to work on this issue. Can I please be assigned?

nityeshaga avatar Feb 17 '18 14:02 nityeshaga

@nityeshaga , are you still working on this one?

jayvdb avatar Apr 18 '18 08:04 jayvdb

I am so sorry. I totally forgot about the issues assigned to me in this repo. :sweat: :

nityeshaga avatar Apr 18 '18 08:04 nityeshaga

According to my research, here is the list of changes that were made to the CLI since that project:

  • Use letters instead of numbers (actually both are allowed in the current version of coala)
  • 2 new actions - ShowAppliedPatches and GeneratePatches
  • Allow chaining of actions in input (although chained inputs are handled in a different way now, but the basic motive is the same)
  • DoNothingAction set as the default action
  • The apply_single_action feature
  • Reprompt after running an action

Useful links:

  • https://projects.coala.io/#/projects?project=improve_the_coala_cli&lang=en
  • https://github.com/coala/cEPs/blob/master/cEP-0012.md

nityeshaga avatar Apr 18 '18 09:04 nityeshaga

Is this issue still open? I would like to work on it

AprajitaSingh avatar Oct 04 '18 16:10 AprajitaSingh

Please i would like to be assigned to this issue

xurror avatar Mar 12 '19 05:03 xurror