From 8ca0ccff0d0b44c71a08b60aba070b927b397c91 Mon Sep 17 00:00:00 2001 From: Unknown Date: Thu, 25 Oct 2018 15:53:42 +0200 Subject: [PATCH] all .md files: Remove useless whitespaces from markdown files Changes after executing the SpaceConsistency Bear. Closes https://github.com/coala/projects/issues/529 three md files: Fixed typos _faq/gsoc-requirements.md - update spaces _faq/is-mentor-necessary.md - formated text data/locale/en/README.md - restored file Closes https://github.com/coala/projects/issues/529 three markdown files: Fixed typos extended-linter-integration -> add spaces is-mentor-necessary.md -> text in new line gsoc-requirements.md -> format text Closes https://github.com/coala/projects/issues/529 three markdown files: Fixed spaces _faq/gsoc-requirements.md --> Trailing whitespaces _faq/is-mentor-necessary.md --> Trailing whitespaces _projects/extend-linter-integration.md --> Tabs used instead of spaces Closes https://github.com/coala/projects/issues/529 three markdown files: Fixed spaces _faq/gsoc-requirements.md --> Trailing whitespaces _faq/is-mentor-necessary.md --> Trailing whitespaces _projects/extend-linter-integration.md --> Tabs used instead of spaces Closes https://github.com/coala/projects/issues/529 three markdown files: Fixed spaces _faq/gsoc-requirements.md --> Trailing whitespaces _faq/is-mentor-necessary.md --> Trailing whitespaces _projects/extend-linter-integration.md --> Tabs used instead of spaces Closes https://github.com/coala/projects/issues/529 three markdown files: Fixed spaces _faq/gsoc-requirements.md --> Trailing whitespaces _faq/is-mentor-necessary.md --> Trailing whitespaces _projects/extend-linter-integration.md --> Tabs used instead of spaces Closes https://github.com/coala/projects/issues/529 three markdown files: Fixed spaces _faq/gsoc-requirements.md --> Trailing whitespaces _faq/is-mentor-necessary.md --> Trailing whitespaces _projects/extend-linter-integration.md --> Tabs used instead of spaces Closes https://github.com/coala/projects/issues/529 --- README.md | 4 ++-- _faq/gsoc-requirements.md | 3 +-- _faq/i-want-to-do-a-gsoc.md | 2 +- _faq/is-mentor-necessary.md | 2 +- _faq/own-project-idea.md | 2 +- _faq/thesis.md | 4 ++-- _layouts/report.md | 10 +++++----- _projects/automate-dependency-repology.md | 6 +++--- _projects/bear-updates.md | 14 ++++++------- _projects/coala-cli.md | 2 +- _projects/coala-web.md | 8 ++++---- _projects/create-jenkins-plugin.md | 2 +- _projects/documentation-extraction.md | 2 +- _projects/enhance-coala-quickstart.md | 6 +++--- _projects/extend-linter-integration.md | 24 +++++++++++------------ _projects/generic-bears.md | 4 ++-- _projects/gitmate-jira.md | 6 +++--- _projects/gitmate-plugins.md | 24 +++++++++++------------ _projects/gitmate-testing.md | 4 ++-- _projects/go-bears-on-bsd.md | 2 +- _projects/i-gitt-scm-support.md | 6 +++--- _projects/implement-aspects.md | 4 ++-- _projects/improve-diff-handling.md | 6 +++--- _projects/improve-installation.md | 2 +- _projects/nested-languages.md | 2 +- _projects/newcomer-metrics.md | 12 ++++++------ _projects/nextgen-action-system.md | 6 +++--- _projects/optimize-caching.md | 10 +++++----- _projects/roberta-external-source.md | 8 ++++---- _projects/use-coala-3.md | 8 ++++---- _reports/HemangKumar.md | 16 +++++++-------- _reports/RahulJha.md | 16 +++++++-------- _reports/adhikasp.md | 24 +++++++++++------------ _reports/kriti21.md | 2 +- _reports/palash25.md | 2 +- _reports/virresh.md | 12 ++++++------ 36 files changed, 133 insertions(+), 134 deletions(-) diff --git a/README.md b/README.md index aa8bb1cd..22776f9a 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Why? ## Usage To clone the repository and run this website on your local machine, [install Jekyll](https://jekyllrb.com/docs/installation/) for your OS and type the following commands: - + $ sudo gem install jekyll bundler $ git clone https://github.com/coala/projects.git $ cd projects @@ -54,7 +54,7 @@ A sample project definition is available [here](https://github.com/coala/project Users can also add FAQs by simply creating a markdown file in _faq folder. -Format for faq markdown file is as follows: +Format for faq markdown file is as follows: ``` --- Question: diff --git a/_faq/gsoc-requirements.md b/_faq/gsoc-requirements.md index deadc2cd..568d5631 100644 --- a/_faq/gsoc-requirements.md +++ b/_faq/gsoc-requirements.md @@ -5,5 +5,4 @@ Other than the [requirements from Google](https://developers.google.com/open-sou * You have completed the [coala Newcomers guide](https://coala.io/newcomer) * You have a submission to [our usability survey](https://coala.io/usability) - so we know that you know how to *use coala*. - \ No newline at end of file + so we know that you know how to *use coala*. diff --git a/_faq/i-want-to-do-a-gsoc.md b/_faq/i-want-to-do-a-gsoc.md index a72a6196..f62e2677 100644 --- a/_faq/i-want-to-do-a-gsoc.md +++ b/_faq/i-want-to-do-a-gsoc.md @@ -1,5 +1,5 @@ --- question: "I want to do a GSoC!" --- -Great! This is the right place. Check out the other questions and +Great! This is the right place. Check out the other questions and most importantly the projects page. diff --git a/_faq/is-mentor-necessary.md b/_faq/is-mentor-necessary.md index 4e4cb971..d6c19a82 100644 --- a/_faq/is-mentor-necessary.md +++ b/_faq/is-mentor-necessary.md @@ -1,6 +1,6 @@ --- question: "A showcased project on the website doesn't have a mentor, but - I'm interested in that project?" + I'm interested in that project?" --- You just have to choose a project and write an awesome proposal. Mentors are set after we choose the projects (which is done by choosing the students). diff --git a/_faq/own-project-idea.md b/_faq/own-project-idea.md index 24c44c5d..a14d19c7 100644 --- a/_faq/own-project-idea.md +++ b/_faq/own-project-idea.md @@ -1,5 +1,5 @@ --- question: "I have an own project idea! (Mentors and students!)" --- -Superb! We recommend you submit your idea to [our projects +Superb! We recommend you submit your idea to [our projects repository](https://github.com/coala/projects) as a pull request. diff --git a/_faq/thesis.md b/_faq/thesis.md index bfd93c5d..0b36d162 100644 --- a/_faq/thesis.md +++ b/_faq/thesis.md @@ -4,7 +4,7 @@ question: "I want to write a thesis with coala!" Great! This is the right place. Check out the other questions and most importantly the projects page. If you have own ideas we recommend you submit them to our [projects -repository](https://github.com/coala/projects) as a pull request -regardless if you want to do them yourself or not. +repository](https://github.com/coala/projects) as a pull request +regardless if you want to do them yourself or not. You can find further information regarding thesis writing with coala [here](http://coala.io/thesis). diff --git a/_layouts/report.md b/_layouts/report.md index 094e147e..df08c50d 100644 --- a/_layouts/report.md +++ b/_layouts/report.md @@ -22,7 +22,7 @@

Google Summer of Code {{ page.date | date: '%Y' }} Work Product Submission


- +
@@ -107,7 +107,7 @@
- +
@@ -127,14 +127,14 @@ {% for commits in page.activity %} - {% for c in commits %} + {% for c in commits %} {{ c[1][0]["repo"] | slice: 0 }}  {{ c[1][0]["repo"] }} View {{ c[1][2]["details"] | markdownify}} - {% endfor %} + {% endfor %} {% endfor %} @@ -148,4 +148,4 @@

- + diff --git a/_projects/automate-dependency-repology.md b/_projects/automate-dependency-repology.md index 98169651..2c222d0c 100644 --- a/_projects/automate-dependency-repology.md +++ b/_projects/automate-dependency-repology.md @@ -37,8 +37,8 @@ installing these dependencies. Repology is a packaging hub. It analyzes a lot of package repositories and other sources, comparing packages versions across them and gatherinng relevant -information. It shows you in which repositories a given project is packaged, -which version is the latest and which needs updating, who maintains the +information. It shows you in which repositories a given project is packaged, +which version is the latest and which needs updating, who maintains the package, and other related information. The student has to use this information and implement improvments to the automated management of dependencies. @@ -57,7 +57,7 @@ suitable scope and make a proposal accordingly. ##### CODING PHASE 1 * All the existing LinterBears and Package Manager classes are connected with their respective Repology IDs. -* Documentation added on how to do the same for new Linter Bears to +* Documentation added on how to do the same for new Linter Bears to [Writing Linter Bears](https://api.coala.io/en/latest/Developers/Writing_Linter_Bears.html) ##### CODING PHASE 2 diff --git a/_projects/bear-updates.md b/_projects/bear-updates.md index 6d68b311..6a715e7f 100644 --- a/_projects/bear-updates.md +++ b/_projects/bear-updates.md @@ -16,7 +16,7 @@ name: "Improve Lint Bear Quality" requirements: - "The participant should have one bugfix patch to any bear accepted." - "The participant should have understanding of the linter and test framework for bears." - - "The proposal should contain issues which are planned to be addressed, chosen + - "The proposal should contain issues which are planned to be addressed, chosen (and potentially [filed](https://github.com/coala/coala-bears/issues/new)) by the student." status: disabled tags: @@ -27,17 +27,17 @@ tags: This project is about improving the general quality of coala's linter bears. -Since it is very easy to write them even for very inexperienced contributors, +Since it is very easy to write them even for very inexperienced contributors, linter bears in coala often suffer from mediocre quality, especially once they made it into the codebase. They do work, but not necessarily on all platforms or for all usecases. They are documented, but not -necessarily understandable. They are tested, but lack corner cases or exploratory tests. +necessarily understandable. They are tested, but lack corner cases or exploratory tests. [See existing issues](https://github.com/coala/coala-bears/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Flintbears) Students working on this project familiarize themselves in-depth with the working of the `linter` decorator and the existing linter bears. They identify systematic issues with the way linter bears are developed and maintained and -work to fix those issues and improve and amend +work to fix those issues and improve and amend [existing documentation](http://api.coala.io/en/latest/Developers/Writing_Linter_Bears.html) to avoid them in the future. A number of existing bears is updated and improved to fit the new standards. @@ -48,7 +48,7 @@ Possible areas to investigate include: cumbersome and ugly to add more test cases. * Support for underlying tool: The support for the underlying tool is mostly left to the contributers discretion. Students could come up with a guideline - on how well a tool's options must be supported and documented or even + on how well a tool's options must be supported and documented or even automated ways to test for this (maybe via a bear?). #### Milestones @@ -61,9 +61,9 @@ Possible areas to investigate include: ##### CODING PHASE 1 - * Ideas for how to solve each of the identified issues are drafted. + * Ideas for how to solve each of the identified issues are drafted. If possible ways to automatically check bears are drafted. - * Changes to the [linter bear documentation](http://api.coala.io/en/latest/Developers/Writing_Linter_Bears.html) + * Changes to the [linter bear documentation](http://api.coala.io/en/latest/Developers/Writing_Linter_Bears.html) to improve quality of future bears are proposed. * A list of bears which suffer from any of the identified issues is composed. diff --git a/_projects/coala-cli.md b/_projects/coala-cli.md index fbb70213..a0e96e89 100644 --- a/_projects/coala-cli.md +++ b/_projects/coala-cli.md @@ -148,5 +148,5 @@ https://github.com/coala/coala/issues/2912 https://github.com/coala/coala/issues/2699 https://github.com/coala/coala/issues/2541 -GSoC Proposal for this project:- +GSoC Proposal for this project:- https://docs.google.com/document/d/10FHYhRzK9IxroDoPxI5V_nWCR3DO-g-C-g12B0WKkQA/edit?usp=sharing diff --git a/_projects/coala-web.md b/_projects/coala-web.md index e102b39a..528fe2cd 100644 --- a/_projects/coala-web.md +++ b/_projects/coala-web.md @@ -41,12 +41,12 @@ tags: This project aims to increase the user base of coala and provide a web based interface to use coala on their projects. The project is conceptually built upon -various previous projects (coala-gui, coala-html) which have helped us refine, +various previous projects (coala-gui, coala-html) which have helped us refine, redefine and revisit our GUI approach. By providing first time users a one click interface to obtain a coafile online and to run coala at coala.io on their projects by two means, by pasting the code -in the given editor box, and by pasting the link to their GitHub repository in +in the given editor box, and by pasting the link to their GitHub repository in a link box. This will help them to get started with coala very easily. The next thing where the project will help us is that it will provide an @@ -67,7 +67,7 @@ bot name in the issues section of their GitHub repositories, and then this bot will comment back with a coafile for their project. Additionaly it will also make a Pull Request with that coafile. The prototype can be found [here](https://github.com/hemangsk/gh-node-bot-prototype) and an example issue -is [here](https://github.com/rahulcode22/Hackerrank/issues/6). +is [here](https://github.com/rahulcode22/Hackerrank/issues/6). #### Milestones @@ -97,6 +97,6 @@ from coala-html. * Add CI on landing-frontend, projects and webServices. * Enhance coala-html UI and Add searching and filtering functionality. -* Solve [coala-html#34](https://github.com/coala/coala-html/issues/34) and +* Solve [coala-html#34](https://github.com/coala/coala-html/issues/34) and [coala-html#33](https://github.com/coala/coala-html/issues/33) * Revisit code in landing-frontend, projects and webServices and add tests. diff --git a/_projects/create-jenkins-plugin.md b/_projects/create-jenkins-plugin.md index 5149e133..a0893446 100644 --- a/_projects/create-jenkins-plugin.md +++ b/_projects/create-jenkins-plugin.md @@ -25,7 +25,7 @@ tags: --- **Disabled: This project is not available for GSOC 2018. See Jenkin's GSOC -[page](https://summerofcode.withgoogle.com/organizations/5572716199936000/) +[page](https://summerofcode.withgoogle.com/organizations/5572716199936000/) if you are interested in working with them** Jenkins is the most popular ci-cd server, and there are many corporations diff --git a/_projects/documentation-extraction.md b/_projects/documentation-extraction.md index aa61a864..6403cb27 100644 --- a/_projects/documentation-extraction.md +++ b/_projects/documentation-extraction.md @@ -28,7 +28,7 @@ end up having one. This probably is partly due to the fact that having a second place to write documentation makes it easy to "forget" about it. To solve this problem, and -also to offer developers easier access to some important information, many +also to offer developers easier access to some important information, many languages support having documentation in source files. The problem with this is, that most linters only work on code or pure documentation files but can not lint documentation in source files. This leads to a lack of checks for in diff --git a/_projects/enhance-coala-quickstart.md b/_projects/enhance-coala-quickstart.md index 4ae4d578..3db94a55 100644 --- a/_projects/enhance-coala-quickstart.md +++ b/_projects/enhance-coala-quickstart.md @@ -51,9 +51,9 @@ However, there’s scope for improvement in the following areas: files are to be linted with csslint, we could use this information to target CSSLintBear at exactly these files. - Improving the interface: - - Removing non user-friendly warnings. - - Increasing automation. - - Validate user input before writing to the generated coafile. + - Removing non user-friendly warnings. + - Increasing automation. + - Validate user input before writing to the generated coafile. - Continuous Integration: Like other coala repositories, add Appveyor (Windows) and Travis (OSX) integartions. diff --git a/_projects/extend-linter-integration.md b/_projects/extend-linter-integration.md index 51352a83..0e55f5e4 100644 --- a/_projects/extend-linter-integration.md +++ b/_projects/extend-linter-integration.md @@ -80,8 +80,8 @@ challenging task. Hit and trial methods or the usage of a debugger are the only possible ways to overcome these errors. ``` E AssertionError: Lists differ: [<Result object(id=0xce0383d576a84f34848d66d0ddc87479, origin=[632 chars] - 710>] != [<Result object(id=0x7e58527926a345f8a2bb36305c58f9f6, origin=[632 chars]400>] -E + 710>] != [<Result object(id=0x7e58527926a345f8a2bb36305c58f9f6, origin=[632 chars]400>] +E E First differing element 0: E <Result object(id=0xce0383d576a84f34848d66d0ddc87479, origin=[631 chars]0710> E <Result object(id=0x7e58527926a345f8a2bb36305c58f9f6, origin=[631 chars]0400> @@ -93,12 +93,12 @@ difficult to debug things like: E AssertionError: 0 == 0 : The local bear 'CheckstyleBear' yields no result although it should. E Running bear CheckstyleBear... E Running 'java -jar /home/ubuntu/.local/share/coala-bears/CheckstyleBear/checkstyle.jar -c /home/ubuntu/ - .local/share/coala-bears/CheckstyleBear/google.xml /home/ubuntu/coala-bears/tests/java/test_files/ - CheckstyleGood.java' + .local/share/coala-bears/CheckstyleBear/google.xml /home/ubuntu/coala-bears/tests/java/test_files/ + CheckstyleGood.java' E Running bear CheckstyleBear... E Running 'java -jar /home/ubuntu/.local/share/coala-bears/CheckstyleBear/checkstyle.jar - -c /home/ubuntu/.local/share/coala-bears/CheckstyleBear/google.xml - /home/ubuntu/coala-bears/tests/java/test_files/CheckstyleBad.java' + -c /home/ubuntu/.local/share/coala-bears/CheckstyleBear/google.xml + /home/ubuntu/coala-bears/tests/java/test_files/CheckstyleBad.java' tests/LocalBearTestHelper.py:34: AssertionError ``` @@ -194,12 +194,12 @@ to the user from a variety of local and global bears with the goal of appending the following bears : * [StylintBear](https://github.com/coala/coala-bears/issues/754) -* [TextLintBear](https://github.com/coala/coala-bears/issues/1576) -* [ReekBear](https://github.com/coala/coala-bears/issues/439) -* [TravisLintBear](https://github.com/coala/coala-bears/issues/294) -* [PugLintBear](https://github.com/coala/coala-bears/issues/290) -* [CSSCombBear](https://github.com/coala/coala-bears/issues/634) -* [AstyleBear](https://github.com/coala/coala-bears/issues/388) +* [TextLintBear](https://github.com/coala/coala-bears/issues/1576) +* [ReekBear](https://github.com/coala/coala-bears/issues/439) +* [TravisLintBear](https://github.com/coala/coala-bears/issues/294) +* [PugLintBear](https://github.com/coala/coala-bears/issues/290) +* [CSSCombBear](https://github.com/coala/coala-bears/issues/634) +* [AstyleBear](https://github.com/coala/coala-bears/issues/388) * [HttpoliceBear](https://github.com/coala/coala-bears/issues/596) #### Milestones diff --git a/_projects/generic-bears.md b/_projects/generic-bears.md index 1d080aa5..1c360d1b 100644 --- a/_projects/generic-bears.md +++ b/_projects/generic-bears.md @@ -16,7 +16,7 @@ requirements: - "The participant should have one bugfix patch to any bear accepted." - "The participant should have an understanding of the algorithms behind existing Generic bears and test framework for bears." - - "The proposal should contain issues which are planned to be addressed, + - "The proposal should contain issues which are planned to be addressed, chosen (and potentially [filed](https://github.com/coala/coala-bears/issues/new)) by the student." tags: @@ -50,7 +50,7 @@ Until then, they are mere prototypes to feed the everlasting hunger of new and cool things. These bears can be found [here](https://github.com/coala/coala-bears/tree/master/bears/general). Issues -related to generic bears can be found +related to generic bears can be found [here](https://github.com/coala/coala-bears/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Aarea%2Fgenericbears%20). The task is to fix as many issues with these bears and make them as usable diff --git a/_projects/gitmate-jira.md b/_projects/gitmate-jira.md index 7819c7b6..6fcdaa79 100644 --- a/_projects/gitmate-jira.md +++ b/_projects/gitmate-jira.md @@ -52,15 +52,15 @@ tags: [Jira](https://www.atlassian.com/software/jira) support. Many open source projects and companies use Jira. -For more information about Jira and their REST API, you can look at +For more information about Jira and their REST API, you can look at [an existing Python implementation](https://github.com/pycontribs/jira#jira-python-library). This project involves adding a Jira implementation to [IGitt](https://gitlab.com/gitmate/open-source/IGitt/) as well as using that within [GitMate.io](https://gitmate.io/) (i.e. add webhooks and "signup with jira"). We look forward to hearing about your approach to making this happen. If you -want, you can define optional goals which could be little snippets of -automation targeted to Jira users. +want, you can define optional goals which could be little snippets of +automation targeted to Jira users. (See also [our documentation about creating plugins](http://docs.gitmate.io/Developers/Writing_Plugin/).) Please ask us for a Jira license to play around with at any time. diff --git a/_projects/gitmate-plugins.md b/_projects/gitmate-plugins.md index b2cc3318..4d578a7d 100644 --- a/_projects/gitmate-plugins.md +++ b/_projects/gitmate-plugins.md @@ -3,7 +3,7 @@ name: "Implement GitMate Plugins for coala" desc: "GitMate.io helps by automating tasks on GitHub and GitLab. There are new plugins that are specific to coala that should be implemented. " requirements: - - "The participant should have at least one patch to + - "The participant should have at least one patch to [GitMate](https://gitlab.com/gitmate/open-source/gitmate-2) accepted." mentors: - nkprince007 @@ -28,23 +28,23 @@ collaborating_projects: - IGitt --- -[GitMate.io](https://gitmate.io/) is an automation tool for developers. -While it works well, there are a number of plugins that could automate tasks +[GitMate.io](https://gitmate.io/) is an automation tool for developers. +While it works well, there are a number of plugins that could automate tasks to save maintainer time (for example automatically close PRs from master). -[IGitt](https://igitt.gitmate.io/index.html) is a Git hoster abstraction +[IGitt](https://igitt.gitmate.io/index.html) is a Git hoster abstraction for python. It's an extensive framework that will help implement GitMate's plugins. -To get started on GitMate, please follow +To get started on GitMate, please follow [our guide](http://docs.gitmate.io/Developers/Newcomers_Guide/). #### Plugin Ideas -* Reject Pull Requests from master. Should include - instructions on how to create a new branch, fix the master branch, and +* Reject Pull Requests from master. Should include + instructions on how to create a new branch, fix the master branch, and resubmit a PR. * Fixes vs Closes automated checking. -* A squash command to fix a PR with many messy commits. +* A squash command to fix a PR with many messy commits. Should link to the coala's git documentation for future reference * Automatically mark PRs as WIP if GitMate's coala plugin finds defects. * Similarly mark PRs as WIP if CI tests fail. @@ -52,9 +52,9 @@ To get started on GitMate, please follow #### Configuration -Currently, it is difficult to apply the same rules to different repositories. -GitMate should have some method of configuring multiple settings for many -repositories. This configuration management must +Currently, it is difficult to apply the same rules to different repositories. +GitMate should have some method of configuring multiple settings for many +repositories. This configuration management must support all existing plugins and be capable of supporting new plugins as well. #### Milestones @@ -64,7 +64,7 @@ support all existing plugins and be capable of supporting new plugins as well. ##### CODING PHASE 1 * Fixes vs Closes automated checking should be implemented. -* Implement "recheck" command for cases where issues unrelated to the +* Implement "recheck" command for cases where issues unrelated to the PR cause tests to fail. * Squash command implemented. * Implement auto-assign issue based on commit mention. diff --git a/_projects/gitmate-testing.md b/_projects/gitmate-testing.md index 4aaa893b..00433564 100644 --- a/_projects/gitmate-testing.md +++ b/_projects/gitmate-testing.md @@ -2,7 +2,7 @@ collaborating_projects: - GitMate desc: "GitMate.io is now an MVP with proper unit tests. However, we still lack - support for quick integration tests on feature additions and bug fixes. + support for quick integration tests on feature additions and bug fixes. Kudos, if you could help us with that." developers_involved: [] difficulty: medium @@ -79,7 +79,7 @@ We have a whole lot of mocking before the actual testing begins. Therefore, we would like to see a clearly determined and viable approach with examples as to how they would simplify the testing in the applicant's proposal. -Refer our base, +Refer our base, [GitmateTestCase](https://gitlab.com/gitmate/open-source/gitmate-2/blob/master/gitmate_config/tests/test_base.py) for more details on how our tests are run. diff --git a/_projects/go-bears-on-bsd.md b/_projects/go-bears-on-bsd.md index f74b8bf8..531d220e 100644 --- a/_projects/go-bears-on-bsd.md +++ b/_projects/go-bears-on-bsd.md @@ -98,5 +98,5 @@ automatically using Repology on multiple operating systems. implemented and tested. * The student has set up an official CI server to the working repo for testing on FreeBSD. -* Documentation added on how to do the same for new Linter Bears to +* Documentation added on how to do the same for new Linter Bears to [Writing Linter Bears](https://api.coala.io/en/latest/Developers/Writing_Linter_Bears.html). diff --git a/_projects/i-gitt-scm-support.md b/_projects/i-gitt-scm-support.md index 38afff58..4103417b 100644 --- a/_projects/i-gitt-scm-support.md +++ b/_projects/i-gitt-scm-support.md @@ -31,9 +31,9 @@ However, there are some git hosters that are not yet supported by IGitt. One such hoster is BitBucket. So it is necessary to add BitBucket support to IGitt before using it to convert the VCS bears in coala-bears. -Other git hosters like Gerrit and Phabricator are important for IGitt adoption +Other git hosters like Gerrit and Phabricator are important for IGitt adoption into large OSS organizations. So are some other non-git SCM, such as Fossil -and Launchpad. +and Launchpad. Support for all these git hosters should be added to IGitt. @@ -65,5 +65,5 @@ for this project is to make an enhancement to https://github.com/guyzmo/git-repo ##### CODING PHASE 3 -* Submit the new backends to the main IGitt repo hosted on GitLab. +* Submit the new backends to the main IGitt repo hosted on GitLab. * Add Fossil and Launchpad support to IGitt. diff --git a/_projects/implement-aspects.md b/_projects/implement-aspects.md index e2e1030e..ce9e2172 100644 --- a/_projects/implement-aspects.md +++ b/_projects/implement-aspects.md @@ -125,6 +125,6 @@ and compare the result. * Ensure backward compatibility with old bears and configuration file. * Everything is documented properly. * Write AutoflakeBear that will use all of the aspect feature as a proof of - works. -* Integration test, run and compare coala result in a project with the new + works. +* Integration test, run and compare coala result in a project with the new aspect configuration and old configuration setup. diff --git a/_projects/improve-diff-handling.md b/_projects/improve-diff-handling.md index 647fdeae..f8748d13 100644 --- a/_projects/improve-diff-handling.md +++ b/_projects/improve-diff-handling.md @@ -66,7 +66,7 @@ followed. Candidate is expected to incorporate their own ideas and designs. | | | PlaceholderName : Help string related to the placeholder. | | | More placeholders (only 2-3 placeholders are described, others(if any) can be displayed | | | when the user selects to apply the Interactive Patch. -| | *0: Do nothing +| | *0: Do nothing | | 1: Open file(s) | | 2: Apply interactive Patch | | 3: Add ignore comment @@ -99,7 +99,7 @@ the help of `fix_generation_function`. | | 2: Apply patch | | 3: Add ignore comment | | 4: Show patch 2 (default name for the action, but can be customized) -| | 5: Show patch 3 (This option changes into “More Patches” option, +| | 5: Show patch 3 (This option changes into “More Patches” option, | | if there are more that 3 suggested patches) | | Enter number (Ctrl-D to exit): ``` @@ -128,7 +128,7 @@ Example for a `NamingBear` | | | + {max_student_limit} = 5 | | *0: Do nothing | | 1: Open file(s) -| | 2: Apply patch (changes Max_studentLimit to max_student_limit, has highest +| | 2: Apply patch (changes Max_studentLimit to max_student_limit, has highest confidence due to user\'s snake-case preference in coafile) | | 3: Apply interactive patch (to let the user manually change the variable name) | | 4: Show CONSTANTS patch (python specific, will propose to use MAX_STUDENT_LIMIT) diff --git a/_projects/improve-installation.md b/_projects/improve-installation.md index c288621a..eab65ff3 100644 --- a/_projects/improve-installation.md +++ b/_projects/improve-installation.md @@ -1,7 +1,7 @@ --- collaborating_projects: - coala -desc: "This project is about improving the +desc: "This project is about improving the [bear installation tool](https://gitlab.com/coala/cib) and working around platform dependent requirements." difficulty: medium diff --git a/_projects/nested-languages.md b/_projects/nested-languages.md index bc930df5..546e60ce 100644 --- a/_projects/nested-languages.md +++ b/_projects/nested-languages.md @@ -1,7 +1,7 @@ --- collaborating_projects: - coala -desc: "Multiple programming languages can coexist in the same source +desc: "Multiple programming languages can coexist in the same source file - coala should support writing code analysis that only works on parts of files." difficulty: high diff --git a/_projects/newcomer-metrics.md b/_projects/newcomer-metrics.md index f9aaf45f..5be513db 100644 --- a/_projects/newcomer-metrics.md +++ b/_projects/newcomer-metrics.md @@ -22,27 +22,27 @@ tags: --- coala tries to be a welcoming organisation for newcomers, giving them clear -pathways and as much direct assistance as needed and possible, and using +pathways and as much direct assistance as needed and possible, and using automation tools to reduce the load on the core team. We need to measure our community's success in this department, in order to identify problems and constantly improve. We can also use metrics to gamify this process, allowing newcomers to see how they performed at the newcomer process compared to other newcomers, and giving badges to newcomers who perform -particularly well, and badges to developers who spend their time assisting a -newcomer through the process successfully. The inverse is also possible, +particularly well, and badges to developers who spend their time assisting a +newcomer through the process successfully. The inverse is also possible, allowing the core team to evaluate when someone has consumed too much time with -too little progress, and allowing the newcomer and their peers to see cold +too little progress, and allowing the newcomer and their peers to see cold facts that show who is taking too long to complete the process. The primary metric measured is the time period for each newcomer from first sighting on github/gitter, to the merge of a PR for a low difficulty issue that was not created by the newcomer, and a ‘suggestions requested’ review of a low -difficulty PR by another community member and the review endorsed by a +difficulty PR by another community member and the review endorsed by a maintainer with a ‘+1’.(meta-reviews) This will require that issues are manually downgraded to 'difficulty/newcomer' -if they were not actually the 'difficulty/low' originally expected, and each +if they were not actually the 'difficulty/low' originally expected, and each newcomer knows they need to have a maintainer super-review their review, and actively beg for this super-review. diff --git a/_projects/nextgen-action-system.md b/_projects/nextgen-action-system.md index 160d68ee..e4e12eb3 100644 --- a/_projects/nextgen-action-system.md +++ b/_projects/nextgen-action-system.md @@ -21,11 +21,11 @@ coala needs to have a global set of actions that it tries to apply on all tries to apply it but it needs to do that for every `Result` that every bear ever generates. -We need a way allow results to define actions by themselves, like +We need a way allow results to define actions by themselves, like `result = Result(actions=[ApplyPatchAction, ...]). Here is the benefit of such an approach: * Bears can specify their own actions, for example the GitCommitBear would - highly benefit from this (actions could be added for amending commits). Then, + highly benefit from this (actions could be added for amending commits). Then, the bear writers could get much more creative and generate even more useful bears. @@ -36,7 +36,7 @@ an approach: * Student should have a clear plan and conceptual work must be finished. * The applicant should know how to work with the community. -##### CODING PHASE 1 +##### CODING PHASE 1 * Changes to the `Result` class must be finished including writing tests and documentation. diff --git a/_projects/optimize-caching.md b/_projects/optimize-caching.md index 570e8708..e6b840cf 100644 --- a/_projects/optimize-caching.md +++ b/_projects/optimize-caching.md @@ -60,9 +60,9 @@ increase performance even further. * The applicant has identified at least 3 other performance bottlenecks that can be improved. These can be smaller improvements, focussing on one particular aspect of coala's core. -* The applicant has drafted and merged a [cEP](https://github.com/coala/ceps) +* The applicant has drafted and merged a [cEP](https://github.com/coala/ceps) describing all the proposed changes thoroughly. -* Preliminary prototypes have been tested to validate the proposed changes' +* Preliminary prototypes have been tested to validate the proposed changes' performance improvements. ##### CODING PHASE 1 @@ -78,10 +78,10 @@ increase performance even further. ##### CODING PHASE 2 * The Proposed change to ignore unchanged directories has been implemented. -* Thorough tests have been performed to concretely ascertain a measurable +* Thorough tests have been performed to concretely ascertain a measurable performance gain. * At least one of the cache control flags have been implemented. -* The corresponding code has been thoroughly tested, documented, reviewed, and +* The corresponding code has been thoroughly tested, documented, reviewed, and merged. ##### CODING PHASE 3 @@ -89,5 +89,5 @@ increase performance even further. * All the remaining cache control flags like `--cache-optimize`, `--cache-compression`, etc have been implemented. * The corresponding code is properly tested, documented, reviewed, and merged. -* A final report describing the measured performance improvements for the +* A final report describing the measured performance improvements for the various implemented techniqes has been published. diff --git a/_projects/roberta-external-source.md b/_projects/roberta-external-source.md index 458153fd..63a6f0d4 100644 --- a/_projects/roberta-external-source.md +++ b/_projects/roberta-external-source.md @@ -17,15 +17,15 @@ name: "One click linting for online projects in the browser" requirements: - "The applicant should be be familiar with bear creation and XML parsing using xpath or a similar query language" - "The applicant should be reasonable familiar with the coala codebase and the workings of REST APIs, including - authentication." + authentication." - "The applicant has contributed to a relevant coala module, the Open Roberta platform, or both." tags: - Bears - Web --- -**Disabled: This project is not available for GSOC 2018. -See OpenRoberta's GSOC +**Disabled: This project is not available for GSOC 2018. +See OpenRoberta's GSOC [page](https://summerofcode.withgoogle.com/organizations/6256279438229504/) if you are interested in working with them** @@ -66,7 +66,7 @@ additional certification through Fraunhofer IAIS in Sankt Augustin, Germany. * Familiarity with the OpenRoberta partner project is established and a method for external access is designed and implemented in a basic fashion * A design goal is reached with the coala project on how to integrate external - data sources into the coala web page, including mock-ups and a prototype + data sources into the coala web page, including mock-ups and a prototype implementation for the UI ##### CODING PHASE 1 diff --git a/_projects/use-coala-3.md b/_projects/use-coala-3.md index e7b854a8..12efa83c 100644 --- a/_projects/use-coala-3.md +++ b/_projects/use-coala-3.md @@ -77,10 +77,10 @@ Your remote list should now look like: ```bash $ git remote -v -myfork git@github.com:/.git (fetch) -myfork git@github.com:/.git (push) -origin https://github.com// (fetch) -origin https://github.com// (push) +myfork git@github.com:/.git (fetch) +myfork git@github.com:/.git (push) +origin https://github.com// (fetch) +origin https://github.com// (push) ``` ## Create a clean branch diff --git a/_reports/HemangKumar.md b/_reports/HemangKumar.md index d23f86ad..36fe322a 100644 --- a/_reports/HemangKumar.md +++ b/_reports/HemangKumar.md @@ -19,7 +19,7 @@ phase: - Phase 3 : https://gitlab.com/coala/GSoC/GSoC-2017/milestones/9 bio: > I'm a final year student of Computer Science & Engineering at University School of Information, - Communication & Technology, GGS IP University. I participated in GSoC and worked with [coala](https://coala.io) to facilitate users to use coala online and functionality for one click Git Repository linting. I also worked on a bot to generate coafile, worked on improving UI of coala-html and configurability of coala-projects. I also worked on adding Notification and Thread support in the IGitt library. + Communication & Technology, GGS IP University. I participated in GSoC and worked with [coala](https://coala.io) to facilitate users to use coala online and functionality for one click Git Repository linting. I also worked on a bot to generate coafile, worked on improving UI of coala-html and configurability of coala-projects. I also worked on adding Notification and Thread support in the IGitt library. social: - GitHub: - username: hemangsk @@ -37,9 +37,9 @@ email: hemangsk@gmail.com blog: http://hemangsk.github.io/stories.html activity: - 0: - - repo: coala-quickstart + - repo: coala-quickstart - link: https://github.com/coala/coala-quickstart/commits/master?author=hemangsk - - details: > + - details: > Add --allow-incomplete-sections mode and bump coala version. - 1: - repo: coalaCSS @@ -49,7 +49,7 @@ activity: - 2: - repo: coala Projects - link: https://github.com/coala/projects/commits/master?author=hemangsk - - details: > + - details: > Commits **f26ae52** through **6497def** were part of GSoC. - 3: - repo: IGitt @@ -182,7 +182,7 @@ activity: - 32: - repo: landing-frontend - link: https://github.com/coala/landing-frontend/commits/master?author=hemangsk - - details: > + - details: > Commits **7e2efb3** through **a48a08a** were part of GSoC. --- @@ -195,7 +195,7 @@ The coala Online module now has support for all the bears, bears with optional a
-coala-quickstart has got a new running mode, allow-incomplete-sections which helps users to create a coafile without omitting bears with non optional settings. +coala-quickstart has got a new running mode, allow-incomplete-sections which helps users to create a coafile without omitting bears with non optional settings.
@@ -219,11 +219,11 @@ It was a great learning experience overall, but a few challenges which proved to #### Work to be done -The first task, is to get all the supporting tools like coala Online, coala-html and projects.coala.io need to incooperate user feedback on the changes user experience. +The first task, is to get all the supporting tools like coala Online, coala-html and projects.coala.io need to incooperate user feedback on the changes user experience.
-coafile_bot will be able to do wonders on GitLab as well once GitLab introduces Notification API. Initally I want to promote it as much as I can so that developers can have general awareness about linting, the tools available and how coala comes into the picture, and from there they can use coafile bot and then ultimately improve their git workflow. +coafile_bot will be able to do wonders on GitLab as well once GitLab introduces Notification API. Initally I want to promote it as much as I can so that developers can have general awareness about linting, the tools available and how coala comes into the picture, and from there they can use coafile bot and then ultimately improve their git workflow.
Essentially the projects.coala.io page can be used for a particular program like GSoC, GCI and also for general project management of an organization. Now some organization may want more flexibility on a particular feature. Depending on what more coala needs for project management, and depending upon consensus of other organization voting on a new feature, there is a great room for improvement in projects.coala.io diff --git a/_reports/RahulJha.md b/_reports/RahulJha.md index 5cae4d48..2da00b62 100644 --- a/_reports/RahulJha.md +++ b/_reports/RahulJha.md @@ -44,7 +44,7 @@ activity: - 1: - repo: vulture - link: https://github.com/jendrikseipp/vulture/commit/e5012c424fdba1a6aa0b5da8e9befdf2e98e0fc9 - - details: > + - details: > Add tests for version. - 2: - repo: vulture @@ -149,26 +149,26 @@ activity:
-1.) In addition to the first line of unused code, Vulture now reports the last +1.) In addition to the first line of unused code, Vulture now reports the last line of unused code. The results can now also be sorted according to their size.
-2.) Other than the conventional dead code (defined but not used), vulture +2.) Other than the conventional dead code (defined but not used), vulture now also finds unsatisfiable conditions in `if/while` statements. Also, -any code appearing after `return`, `break`, `continue` and `raise` statements +any code appearing after `return`, `break`, `continue` and `raise` statements is also reported as dead code.
-3.) Confidence values are now reported with every result. Also, a -`min_confidence` parameter can be passed to Vulture. It then only reports +3.) Confidence values are now reported with every result. Also, a +`min_confidence` parameter can be passed to Vulture. It then only reports results for which `confidence` > `min_confidence`.
-4.) The Vulture API has been extended and it now exhibits all characteristics -of dead code, like `confidence`, `first_lineno`, `last_lineno`, `message`, etc. +4.) The Vulture API has been extended and it now exhibits all characteristics +of dead code, like `confidence`, `first_lineno`, `last_lineno`, `message`, etc. It provides user with much more flexibility for automating tests with Vulture.
diff --git a/_reports/adhikasp.md b/_reports/adhikasp.md index 73db49a0..c2772901 100644 --- a/_reports/adhikasp.md +++ b/_reports/adhikasp.md @@ -103,7 +103,7 @@ activity: - repo: coala - link: https://github.com/coala/coala/pull/4397/commits/1622f3042eafb169becd0963e57cc01df53e0750 - details: > - Aspect: Include AspectList in ``__all__`` + Aspect: Include AspectList in ``__all__`` - 13: - repo: coala - link: https://github.com/coala/coala/pull/4397/commits/1ce4dd96a30c2acb913fb9a9f05cfc7dcac87c0f @@ -113,7 +113,7 @@ activity: - repo: coala - link: https://github.com/coala/coala/pull/4397/commits/82d9b0045636819be154792a0c3d81e664c410d4 - details: > - Make Language pickle-able + Make Language pickle-able - 15: - repo: coala - link: https://github.com/coala/coala/pull/4490/commits/579b417f2f043139f3dfd4f97c3cceccc61b1c8f @@ -143,12 +143,12 @@ activity: - repo: coala - link: https://github.com/coala/coala/pull/4532/commits/4de73784a9e89f60077abaf229e22b3ff289f2c8 - details: > - Bear.py: Make ``languages`` JSON compliant + Bear.py: Make ``languages`` JSON compliant - 21: - repo: coala - link: https://github.com/coala/coala/pull/4532/commits/53d6f50dd2c326bca3d83b61137357d8ad7ed62e - details: > - coalaJSONTest: Revert wrong variable usage + coalaJSONTest: Revert wrong variable usage - 22: - repo: autoflake - link: https://github.com/myint/autoflake/pull/23/commits/be622cfd511bb3bb65a36087991cb540ad53a32a @@ -168,12 +168,12 @@ activity: - repo: coala - link: https://github.com/coala/coala/pull/4582/commits/256854c282b3e2a3f80403411aac10309684bfa4 - details: > - AspectTestBear: Fix return result + AspectTestBear: Fix return result - 26: - repo: coala - link: https://github.com/coala/coala/pull/4582/commits/c7135e93d64bf77980a70b03dcac55e4a300a6c5 - details: > - BearTest: Make ``check_message`` could check regex + BearTest: Make ``check_message`` could check regex - 27: - repo: coala - link: https://github.com/coala/coala/pull/4582/commits/1bd2e8793985c2e97605f3f35d563475861d4e7f @@ -223,17 +223,17 @@ activity: - repo: coala - link: https://github.com/coala/coala/pull/4687/commits/1ea2609a43901c775ae48bb1d318e4fdd55279a9 - details: > - Language: Add various language definition stub + Language: Add various language definition stub - 37: - repo: coala - link: https://github.com/coala/coala/pull/4689/commits/30717d6c4183cd309ab827e2c269ef7a9365ad73 - details: > - Language: Add PHP and Fortran language stub + Language: Add PHP and Fortran language stub - 38: - repo: coala - link: https://github.com/coala/coala/pull/4689/commits/ffe3192c2f926bc27dc4dc9c9cfde1284c36f1c5 - details: > - Language: Fix missing or wrong aliases + Language: Fix missing or wrong aliases - 39: - repo: coala - link: https://github.com/coala/coala/pull/4689/commits/2fb27cf8f4399ec6aba36b86d2993e6c3b81d0ee @@ -243,7 +243,7 @@ activity: - repo: coala-bears - link: https://github.com/coala/coala-bears/pull/2023/commits/08cb3b1f66ac7a5ecb880daa19289e89ebd9ecd0 - details: > - TextLintBearTest: Modify `bad_alex_no_dead_link` + TextLintBearTest: Modify `bad_alex_no_dead_link` - 41: - repo: coala-bears - link: https://github.com/coala/coala-bears/pull/2023/commits/52d75b58223cbd88f09701e1755726d953ed42ce @@ -253,7 +253,7 @@ activity: - repo: coala-bears - link: https://github.com/coala/coala-bears/pull/2023/commits/2bff58313dbd12e5ebc00db492496e864f8eb4db - details: > - CPDBear: Use ``language`` correctly + CPDBear: Use ``language`` correctly - 43: - repo: coala-bears - link: https://github.com/coala/coala-bears/pull/2017/commits/ac2a975df48feb9f70f51336640798e185da11eb @@ -263,7 +263,7 @@ activity: - repo: coala-bears - link: https://github.com/coala/coala-bears/pull/2017/commits/1347da8a284b4ba36052f85e201c0eecf0cb5a79 - details: > - PyUnusedCodeBear: Bump autoflake to v0.7 + PyUnusedCodeBear: Bump autoflake to v0.7 - 45: - repo: demo-aspect - link: https://github.com/adhikasp/demo-aspect diff --git a/_reports/kriti21.md b/_reports/kriti21.md index 9255d47d..6d32afe0 100644 --- a/_reports/kriti21.md +++ b/_reports/kriti21.md @@ -56,7 +56,7 @@ activity: - 3: - repo: cEPs - link: https://github.com/coala/cEPs/pull/114/commits/ea25f09ae08b4bc7423453460b14cb16eb3a0db6 - - details: > + - details: > cEP-0016.md: Add cEP for the project. - 4: - repo: coala-bears diff --git a/_reports/palash25.md b/_reports/palash25.md index e8baa3a9..f37b46e6 100644 --- a/_reports/palash25.md +++ b/_reports/palash25.md @@ -87,7 +87,7 @@ activity: - repo: coala - link: https://github.com/coala/coala/commit/81bbca42f82319aed22ba7f90781d886d559d4dd - details: > - NextGen_Core.rst: Update caching section. + NextGen_Core.rst: Update caching section. - 9: - repo: coala - link: https://github.com/coala/coala/commit/87d3dffd1a52c42ac60da0199ee34bd95827b8ff diff --git a/_reports/virresh.md b/_reports/virresh.md index f22bb3dd..5a8f8dbe 100644 --- a/_reports/virresh.md +++ b/_reports/virresh.md @@ -20,7 +20,7 @@ phase: - Phase 2 : https://gitlab.com/coala/GSoC/GSoC-2018/milestones/39 - Phase 3 : https://gitlab.com/coala/GSoC/GSoC-2018/milestones/40 bio: > - Hi ! I am Viresh Gupta, an undergrad student at Indraprastha Institute of + Hi ! I am Viresh Gupta, an undergrad student at Indraprastha Institute of Information Technology, Delhi, India. I love coding in and out and like to lay my hands on whatever tech I can find. I also love to read books, observe nature and star gaze in my free time. I chose coala for my GSoC project @@ -297,10 +297,10 @@ depend on any external linting tools). As an outcome of this project, coala will be able to support any arbitrary language, provided there exists a grammar for it, and thus this project is a -step towards the future of native bear development with coala. +step towards the future of native bear development with coala. -Library availaible at: -Docs hosted at: +Library availaible at: +Docs hosted at: ### Work Done @@ -328,7 +328,7 @@ while leveraging the power of ANTLR. ##### antlr-v4-grammars Some issues were identified with the upstream grammars and were reported, along -with suggested corrections as PR. +with suggested corrections as PR. [Link](https://github.com/antlr/grammars-v4/issues/created_by/virresh) ##### community @@ -355,7 +355,7 @@ commits. ### Challenges -Major challenge in the project for me was to come up with a library design +Major challenge in the project for me was to come up with a library design that's flexible enough to support all grammars, and yet powerful enough to leverage all features provided by a grammar.