Skip to content

Commit

Permalink
all .md files: Remove useless whitespaces from markdown files
Browse files Browse the repository at this point in the history
Changes after executing the SpaceConsistency Bear.

Closes coala#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 coala#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 coala#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 coala#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 coala#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 coala#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 coala#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 coala#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 coala#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 coala#529
  • Loading branch information
SerekKiri committed Oct 25, 2018
1 parent 346464a commit accb78f
Show file tree
Hide file tree
Showing 36 changed files with 133 additions and 134 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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: <Write the question here>
Expand Down
3 changes: 1 addition & 2 deletions _faq/gsoc-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.

so we know that you know how to *use coala*.
2 changes: 1 addition & 1 deletion _faq/i-want-to-do-a-gsoc.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion _faq/is-mentor-necessary.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion _faq/own-project-idea.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions _faq/thesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
10 changes: 5 additions & 5 deletions _layouts/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<h4 class="left light">Google Summer of Code {{ page.date | date: '%Y' }} Work Product Submission </h4>
</div>
<br>
</div>
</div>
<br>
<div class="row no-margin">
<div class="col m6">
Expand Down Expand Up @@ -107,7 +107,7 @@
</div>
</div>
</div>
</div>
</div>
<br>
<div class="row no-margin">
<div class="col m12">
Expand All @@ -127,14 +127,14 @@
</thead>
<tbody class="card activity">
{% for commits in page.activity %}
{% for c in commits %}
{% for c in commits %}
<tr>
<td class="fl">{{ c[1][0]["repo"] | slice: 0 }}</td>
<td class="">&nbsp;{{ c[1][0]["repo"] }}</td>
<td><a href='{{ c[1][1]["link"] }}'>View</a></td>
<td>{{ c[1][2]["details"] | markdownify}}</td>
</tr>
{% endfor %}
{% endfor %}
{% endfor %}
</tbody>
</table>
Expand All @@ -148,4 +148,4 @@
<br><br>
</div>
</body>
</html>
</html>
6 changes: 3 additions & 3 deletions _projects/automate-dependency-repology.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
14 changes: 7 additions & 7 deletions _projects/bear-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

Expand All @@ -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
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion _projects/coala-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions _projects/coala-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion _projects/create-jenkins-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion _projects/documentation-extraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions _projects/enhance-coala-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
24 changes: 12 additions & 12 deletions _projects/extend-linter-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: [&lt;Result object(id=0xce0383d576a84f34848d66d0ddc87479, origin=[632 chars]
710&gt;] != [&lt;Result object(id=0x7e58527926a345f8a2bb36305c58f9f6, origin=[632 chars]400&gt;]
E
710&gt;] != [&lt;Result object(id=0x7e58527926a345f8a2bb36305c58f9f6, origin=[632 chars]400&gt;]
E
E First differing element 0:
E &lt;Result object(id=0xce0383d576a84f34848d66d0ddc87479, origin=[631 chars]0710&gt;
E &lt;Result object(id=0x7e58527926a345f8a2bb36305c58f9f6, origin=[631 chars]0400&gt;
Expand All @@ -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
```
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions _projects/generic-bears.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions _projects/gitmate-jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
24 changes: 12 additions & 12 deletions _projects/gitmate-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -28,33 +28,33 @@ 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.
* Auto-merger created to integrate rebase and ff plugins.

#### 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
Expand All @@ -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.
Expand Down
Loading

0 comments on commit accb78f

Please sign in to comment.