Teammates: Different types of styles/fonts used in staticAnalysis.md

Created on 17 Mar 2017  路  10Comments  路  Source: TEAMMATES/teammates

Take a look the image below.

imageedit_5_5777107652

This is not the only one. It's also repeated. I think its better to use only one format, may be the 2nd one is better instead of using # . It's happening because of the missing space.

a-Docs good first issue p.Medium

Most helpful comment

Hi @sravi4701 . Before you work on the issue, please follow our Contributor Orientation Guidelines.

All 10 comments

Confirm in 9168d13, It turns out that there should be a space between ##### and title name.
e.g.

Configuring Checkstyle Eclipse plugin (wrong way)
Configuring Checkstyle Eclipse plugin (Correct way)

I think it was there earlier also i guess. In the commit 8db7d17 where IntelliJ support was added. In that case also it was present. I am not able to find since from which commit it was present.

@xpdavid This can be a first timer issue once it's defined more clearly.

Yeah, as only spaces has to be removed.

edit : removed --> added.

Yeah, as only spaces has to be added.
@AnaghHegde Maybe you want to provide more details so that other developers can work on it?

In the staticAnalysis.md page there is a missing space in some of the sub headings. They are as follows

  • Configuring Checkstyle Eclipse plugin
  • Suppressing Checkstyle warnings
  • Configuring PMD Eclipse plugin

For example :
actual :

Configuring Checkstyle Eclipse plugin

expected :

Configuring Checkstyle Eclipse plugin

To correct this add a space between #### and next word.

@xpdavid In the same page

Suppressing PMD warnings To introduce code that violates PMD rules, use @SuppressWarnings("PMD.RuleName")

It should be like this

Suppressing PMD warnings

To introduce code that violates PMD rules, use @SuppressWarnings("PMD.RuleName")

Shall i open a new issue or will track this one also in the same issue ?.

Shall i open a new issue or will track this one also in the same issue ?

Given that we are short of d.FirstTimer issues, it's fine to have one issue per file (but not one issue per each typo). If the typos are in the same file, one issue can cover all of them.

I want to work on this issue. How should I get started?

Hi @sravi4701 . Before you work on the issue, please follow our Contributor Orientation Guidelines.

Was this page helpful?
0 / 5 - 0 ratings