InnerSourcePatterns icon indicating copy to clipboard operation
InnerSourcePatterns copied to clipboard

When is the best point in time to apply markdown linting?

Open spier opened this issue 4 years ago • 1 comments

I noticed that when a new pattern is contributed, often as level1-initial, our automatic markdown linter typically finds a lot of errors in the formatting of the new pattern.

For example see this linter log.

That also means that a new contributor might receive notifications about such linter errors, before they have received any other feedback from the maintainers of the InnerSourcePatterns about the content of their pattern.

That feels like emphasizing syntax over content to me, and I am wondering if that leads to a positive experience for first-time-contributors?

Alternatively to how we are doing it today we could only check the markdown format at a later stage of pattern maturity e.g. when it is leveled up from Initial to Structures.

spier avatar Aug 08 '21 16:08 spier

@gyehuda as you have just opened your first PR with a new pattern, you have probably experienced this situation. Would you mind sharing any feedback that you have related to the markdown linting and the (email) notifications related to this?

spier avatar Aug 08 '21 16:08 spier