Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Long, formatted description for rules supporting markup #412

Open
6 tasks
DirkMahler opened this issue Apr 6, 2022 · 0 comments
Open
6 tasks

Long, formatted description for rules supporting markup #412

DirkMahler opened this issue Apr 6, 2022 · 0 comments

Comments

@DirkMahler
Copy link
Member

I, as a rule provider
would like to add a long formatted description to a rule containing code examples
to that a developer may get a better understanding of "invalid" and "valid" code (similar to SonarQube)

So there should be two descriptions:

  • a short plain text descriptions which already exists

  • a long description which supports markup like Asciidoc which may contain code snippets and can be rendered

  • We got a final feedback from the reporting user (if applicable)

  • Unittests have been written (if applicable)

  • Integration tests have been written (if applicable)

  • Test coverage is the same or even better then before (if applicable)

  • Documentation has been written (if applicable)

  • Added a note on the new feature to the release notes (if applicable)

@DirkMahler DirkMahler changed the title New Feature Long, formatted description for rules supporting markup Jun 28, 2022
@yaseno2186 yaseno2186 transferred this issue from jqassistant-archive/jqa-core-framework Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant