search

chaoss / wg-metrics-models

Working Group for Metrics Model
MIT License
12 stars 22 forks source link

Starter Project Health Metrics Model #74

Closed geekygirldawn closed 1 year ago

geekygirldawn commented 1 year ago

Here's the PR for the new Starter Project Health Metrics model based on the Google Doc and as described in Issue #69

geekygirldawn commented 1 year ago

@germonprez @klumb @ElizabethN - do we have a preference for adding / not adding line breaks in markdown files? I usually try to add a line break to end up with lines at a max of ~80 chars? As a vim user, this makes editing the files a lot easier for me, and it's standard coding practice, but one can argue that markdown isn't really "code", so I'm not sure if we care about this either way. @tsadler1988 created a PR to remove all of the line breaks, but I wanted to see if we have a preference as a project before deciding whether to merge it.

Does it make a difference either way when the markdown files are displayed in Wordpress? Do we have a preference for this as a project?

klumb commented 1 year ago

I don't believe we have offered any guidance on this in the past, and I can't think of any issues we have had with formatting on WordPress or in the PDF releases due to the inclusion (or non-inclusion) of line breaks.

I may be wrong here, but my understanding is that the preference for not using linebreaks in markdown is because when the document is edited in the future (by other people), the chance of formatting errors occurring is reduced (i.e. linebreaks potentially result in future formatting errors). However, there is a good chance formatting issues will be caught during the review (or reported by website visitors) so it is a bit of a non-issue for me. If there is another reason please let me know.