Problem: Archivematica markdown formatting rules in repositories are not clear

[ross-spencer]

Please describe the problem you'd like to be solved.

There are three parts to this issue:

• Some repositories do not have CONTRIBUTING.md/
• Some repositories do not have style guidelines for docs.
• Guidance on markdown formatting guidance, specifically README.md like MD could potentially be developed further.

We may just need to confirm (and link-to) in various repositories that our de-facto guidance for style and contributing are:

• https://github.com/artefactual/archivematica-docs/blob/1.9/style_guide.md
• https://github.com/artefactual/archivematica/blob/stable/1.9.x/CONTRIBUTING.md

Other issues exist for repos without this information too:

• https://github.com/archivematica/Issues/issues/430
• https://github.com/archivematica/Issues/issues/429
• via @ablwr related issue in automation tools: https://github.com/artefactual/automation-tools/issues/90

I did some analysis about ways of adhering to good community standards for CONTRIBUTING, CODE_OF_CONDUCT in other repositories, and other files, and I don't think there is a quick way for solving this either: https://github.com/archivematica/Issues/issues/429#issuecomment-456381223

Describe the solution you'd like to see implemented.

I haven't solutions for each of these issues, Different repositories might have different requirements. What is intriguing is that markdown linting tools do exist such as markdownlint used by @ablwr:

This could be added to our Travis CI scripts to validate formatting for us. This is good for code review because then the focus is on the intellectual payload and not the formatting. This blog describes one travis ci integration approach:

language: node_js
node_js:
- '6'
install:
- npm install -g markdownlint-cli
script:
- markdownlint *.md

Describe alternatives you've considered.

@kevinbowrin also created this tool for our docs: https://github.com/kevinbowrin/docmatica which might also be considered.

Additional context

No further context.

---

For Artefactual use: Please make sure these steps are taken before moving this issue from Review to Verified in Waffle:

• All PRs related to this issue are properly linked 👍
• All PRs related to this issue have been merged 👍
• Test plan for this issue has been implemented and passed 👍
• Documentation regarding this issue has been written and it has been added to the release notes, if needed 👍

[ablwr]

Related issue in the automation-tools repo: artefactual/automation-tools#90 (accidentally posted that in the other issue)