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

Jump to bottom

Style: one sentence per line in READMEs #113

Closed
ivanperez-keera opened this issue Jan 11, 2024 · 0 comments · Fixed by #118
Closed

Style: one sentence per line in READMEs #113

ivanperez-keera opened this issue Jan 11, 2024 · 0 comments · Fixed by #118
Assignees
@ivanperez-keera
Milestone
humble-2024.01.0

Comments

@ivanperez-keera
Copy link
Contributor

Having long sentences in READMEs makes them harder to change, and also makes processing the diffs harder (among other disadvantages). Our READMEs should only list a sentence per line (see the one sentence per line principle).

Originally reported by @sea-bass.
@ivanperez-keera ivanperez-keera mentioned this issue Jan 11, 2024
Merged
@ivanperez-keera ivanperez-keera added this to the humble-2024.01.0 milestone Jan 11, 2024
ivanperez-keera pushed a commit that referenced this issue Jan 11, 2024
@sea-bass @ivanperez-keera
Place sentences in separate lines in READMEs (#113).
55cc995 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
ivanperez-keera added a commit that referenced this issue Jan 11, 2024
@ivanperez-keera
Place sentences in separate lines in READMEs (#113).
3190c21 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
@ivanperez-keera ivanperez-keera self-assigned this Jan 11, 2024
ivanperez-keera pushed a commit that referenced this issue Jan 12, 2024
@sea-bass @ivanperez-keera
Place sentences in separate lines in READMEs (#113).
211d91e 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
ivanperez-keera added a commit that referenced this issue Jan 12, 2024
@ivanperez-keera
Place sentences in separate lines in READMEs (#113).
7764129 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
@github-project-automation github-project-automation bot moved this from In Review to Done in Space ROS Project Development Jan 13, 2024
@Bckempa Bckempa linked a pull request Jan 15, 2024 that will close this issue
Place sentences in separate lines in READMEs (#113). #118
Merged
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@sea-bass @eholum
Place sentences in separate lines in READMEs (space-ros/docker#113).
51ff647 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@ivanperez-keera @eholum
Place sentences in separate lines in READMEs (space-ros/docker#113).
308f578 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@sea-bass @ivanperez-keera
Place sentences in separate lines in READMEs (space-ros/docker#113).
6bf95e1 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@ivanperez-keera
Place sentences in separate lines in READMEs (space-ros/docker#113).
2fadd00 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@ivanperez-keera
Merge remote-tracking branch 'origin/dev-readme-splitlines'. Close sp…
ab0cf90 
…ace-ros/docker#113.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@sea-bass @ivanperez-keera
Place sentences in separate lines in READMEs (space-ros/docker#113).
d407400 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@ivanperez-keera
Place sentences in separate lines in READMEs (space-ros/docker#113).
630f913 
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
eholum pushed a commit to eholum/space-ros that referenced this issue Jun 26, 2024
@ivanperez-keera
Merge remote-tracking branch 'origin/dev-readme-splitlines'. Close sp…
5804401 
…ace-ros/docker#113.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
None yet
Projects
Space ROS Project Development
Status: Done
Milestone
humble-2024.01.0
Development

Successfully merging a pull request may close this issue.

Place sentences in separate lines in READMEs (#113). space-ros/docker
1 participant
@ivanperez-keera