Closed ByteOtter closed 1 year ago
@ByteOtter Since the Markdown linter complains on Codacy, we should either add one in a separate Pull Request that uses our opinionated style guide for Markdown or we should fixup as much as possible.
@ByteOtter Since the Markdown linter complains on Codacy, we should either add one in a separate Pull Request that uses our opinionated style guide for Markdown or we should fixup as much as possible.
From what I understand, Codacy can't really handle the github specific things. The checkboxes and the title preset for PRs and Issues and such. Do we need a Markdown linter at all? If not we could probably tell Codacy to stop checking these Markdown files by creating a .codacy.yml
like this:
---
exclude_paths:
- ".github/**"
@ByteOtter I think that you are indeed right that Codacy cannot handle the markup defined by GitHub for the templates. I will thus disable the Markdown linter. Out docs are written in RST and as such we only have the README.md
in Markdown.
@ByteOtter I think that you are indeed right that Codacy cannot handle the markup defined by GitHub for the templates. I will thus disable the Markdown linter. Out docs are written in RST and as such we only have the
README.md
in Markdown.
Okay, I just pushed a .codacy.yml
which should prevent Codacy from checking any Markdown files including our README.md
Add templates for issues and pull requests aswell as a workflow to label PRs.