docs: ADR for format and lint tooling #184
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@cpswan I pushed what should be the least cumbersome approach to linting (that plays nice with formatters) that I could come up with in efe018f opened an issue related to this weird behaviour as well: jackdewinter/pymarkdown#1208 |
cpswan
approved these changes
Sep 20, 2024
There was a problem hiding this comment.
Approved, though the doc will need to be massaged a little before publishing.
It might also be worth stating a non goal as mandating certain plugins for IDEs (or even an IDE choice).
Furthermore it could be useful to describe the IDE plugin(s) that are used to obtain the tools.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
- What I did
We have some inconsistencies with our formatting and linting policies mainly occurring in less used file formats like markdown and yaml. This ADR is opened as a discussion for us to address that.
- How I did it
- How to verify it
- Description for the changelog
docs: ADR for format and lint tooling