cplusplus / cplusplus/draft

[checks] Add check for missing whitespace in `if(`, `for(`, `while(`

Open Beginner friendly
#8,098 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

P3-Other
Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

Description

Related to https://github.com/cplusplus/draft/issues/404

Following https://github.com/cplusplus/draft/commit/4b07eceb78339dd9a7206f92d2fc9c31a7a94528, we now consistently use:

  • for (
  • while (
  • if (

always with a separating space in the whole document. While we usually give the editors some freedom when it comes to whitespace, it's worth being at least a bit consistent.

Anyhow, we ought to write some checks in check-source.sh which detect

  • for(
  • while(, or
  • if(

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with check-source.sh and review its existing source checks. Add checks that flag for(, while(, and if( in the draft source; the work is done when these missing-whitespace forms are detected consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell, tex
Domain
documentation, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.