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.

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

Use semantic line breaks in the template text #6

Open
AmeliaBR opened this issue Mar 3, 2019 · 0 comments
Open

Use semantic line breaks in the template text #6

AmeliaBR opened this issue Mar 3, 2019 · 0 comments

Comments

@AmeliaBR
Copy link

AmeliaBR commented Mar 3, 2019

Semantic line breaks make it easier to keep track of edits to prose text, when using git diff and similar tools.

If there were clear line breaks before and after each sentence or major phrase in the template, it would be easy to detect any added or removed phrases in a draft charter.

As an example, this paragraph:

    <p>
      Community Group participants agree to make all contributions in the
      GitHub repo the group is using for the particular document. This may be
      in the form of a pull request (preferred), by raising an issue, or by
      adding a comment to an existing issue.
    </p>

could look like this with semantic breaks

    <p>
      Community Group participants agree to make all contributions
      in the GitHub repo the group is using for the particular document.
      This may be
      in the form of a pull request (preferred),
      by raising an issue,
      or
      by adding a comment to an existing issue.
    </p>

With this structure, edits to a single item in the list, or to the description of the repo location,
can often be isolated to a single line in the source code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant