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.

Sign up for GitHub

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

Update project: Enhance quickstart #296

Merged
merged 2 commits into from
May 26, 2017
Merged

Update project: Enhance quickstart #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7a3507
projects.js: Update issues
satwikkansal May 20, 2017
2d082c8
enhance_quickstart: Update description
satwikkansal May 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions data/projects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,8 +577,19 @@ coala should support generating metrics for your code.",
],
"difficulty" : "medium",
"issues" : [
"https://github.com/coala/coala-quickstart/issues/22",
"https://github.com/coala/coala-quickstart/issues/42"
"https://gitlab.com/coala/GSoC-2017/issues/21",
"https://gitlab.com/coala/GSoC-2017/issues/56",
"https://gitlab.com/coala/GSoC-2017/issues/58",
"https://gitlab.com/coala/GSoC-2017/issues/59",
"https://gitlab.com/coala/GSoC-2017/issues/150",
"https://gitlab.com/coala/GSoC-2017/issues/60",
"https://gitlab.com/coala/GSoC-2017/issues/61",
"https://gitlab.com/coala/GSoC-2017/issues/62",
"https://gitlab.com/coala/GSoC-2017/issues/63",
"https://gitlab.com/coala/GSoC-2017/issues/64",
"https://gitlab.com/coala/GSoC-2017/issues/65",
"https://gitlab.com/coala/GSoC-2017/issues/66",
"https://gitlab.com/coala/GSoC-2017/issues/67"
],
"mentors" : [
"adtac",
Expand Down
55 changes: 31 additions & 24 deletions data/projects/enhance_coala_quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
helps users to quickly get started with coala. It generates a `.coafile`
(coala's configuration file) that is tailored to the project. Currently,
coala-quickstart automatically identifies relevant bears for the project
based on the languages used and has a clean and simple command-line interface
based on the languages used and has a clean and simple command-line interface
for taking user’s input when required.

However, there’s scope for improvement in the following areas:
Expand All @@ -13,43 +13,50 @@ However, there’s scope for improvement in the following areas:
coala-quickstart. For example, if a project's Gulpfile.js specifies which
files are to be linted with csslint, we could use this information to target
CSSLintBear at exactly these files.
- Improving the interface:
- Improving the interface:
- Removing non user-friendly warnings.
- Increasing automation.
- Validate user input before writing to the generated coafile.
- Continuous Integration: Like other coala repositories, add Appveyor
- Continuous Integration: Like other coala repositories, add Appveyor
(Windows) and Travis (OSX) integartions.

In addition to the above changes the applicants are encouraged to come up with
their own ideas.


#### Milestones

##### PREPARATION/BONDING
[BONDING] https://gitlab.com/coala/GSoC-2017/milestones/6
[PHASE 1] https://gitlab.com/coala/GSoC-2017/milestones/20
[PHASE 2] https://gitlab.com/coala/GSoC-2017/milestones/21
[PHASE 3] https://gitlab.com/coala/GSoC-2017/milestones/22
[STRETCH GOALS] https://gitlab.com/coala/GSoC-2017/milestones/41

* The applicant has identified all the kinds of configuration files to be worked
##### [PREPARATION/BONDING](https://gitlab.com/coala/GSoC-2017/milestones/6) 4th May - 29th May
* Identified all the kinds of configuration files to be worked
on in the project.
* The applicant has figured out all the useful information that could be
* Figure out all the useful information that could be
extracted from these files.
* The applicant has made a [cEP](https://coala.io/cep) of the interface
improvements.
* Get the cEP https://github.com/coala/cEPs/issues/80 merged.

##### [CODING PHASE 1: Extracting Information](https://gitlab.com/coala/GSoC-2017/milestones/20) 30th May - 26th June

* The basic structure of the information extraction system is implemented.
* Extract information from `Gruntfile.js`, `package.json` and `Gemfile`.

##### CODING PHASE 1
##### [CODING PHASE 2: Utilizing the Information](https://gitlab.com/coala/GSoC-2017/milestones/21) 30th June - 24th July

* The basic structure of the information extraction and filtering relevant
bears system is implemented.
* coala-quickstart is able to utilize information from at least one of the
configuration files.
* All of the code is properly tested and documented.
* CLI: Add autocomplete feature, add prompts for "detect" and "fix" capabilities.
* Collect and organize bears' metadata.
* Filter and recommend bears after utilizing extracted information.

##### CODING PHASE 2
##### [CODING PHASE 3: CLI enhancements](https://gitlab.com/coala/GSoC-2017/milestones/22) 28th July - 21st August

* Code for rest of the configuration files is merged.
* Add Appveyor and Travis integration.
* All of the code is properly tested and documented.
* Validate user input.
* Fix warning and formattings on the CLI.
* Continuous Integration.
* Complete Pending tasks (if any).

##### CODING PHASE 3
##### [Stretch Goals](https://gitlab.com/coala/GSoC-2017/milestones/4)

* All improvements to the user-interface have been implemented and merged.
* All changes to interface are properly tested and documented.
* Implement `.editorconfig` parser and extract information from `.editorconfig`
* Extract information from other meta-files.
* Smart update of generated `.coafile` w.r.t. changes in meta-files.
* Installing required bear-dependencies using cib.