Skip to content

Use blank lines instead of indentation as issue body markers #163

@firedev

Description

@firedev

Indented lines after the first comment are being removed by automatic code for matters like standardrb and rubocop.

Here is a proposal. White space and indentation is not reliable. Treat non-interrupted comment blocks starting with an issue marker as the issue body. Until the first empty line or the beginning of the next code block:

# TODO: #1 Issue title # # ^ if you need an empty line for aesthetics # # Everything here is added as # an issue body # # ... still the issue body # This comment is left in the code def hello

Note: The body should not start with the blank line in this example. Like with git commit the resulting body should start with the first meaningful line.

# TODO #1 This has only title # 

Originally posted by @firedev in #96 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions