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

Improving issues with issue-comments #452

Open
Denubis opened this issue Jan 2, 2020 · 0 comments
Open

Improving issues with issue-comments #452

Denubis opened this issue Jan 2, 2020 · 0 comments

Comments

@Denubis
Copy link

Denubis commented Jan 2, 2020

We all have had "fun" removing the pro-forma text in our default issues. When commenting on a different project, I saw that they took advantage of HTML comments to provide instructional text (as well as different types of issue buttons for different types of instructional text.

The below is a test of our default comment instructions, which should not appear in cursory viewing of the issue (but should appear when viewing source)

Comment start:

Comment end:

An HTML comment takes the form of: <!-- Please delete ... -->, but browsers do not render it.

Comment start:

Comment end: The above test is a test of a multi-paragraph comment. You should not see the normal proforma "email team" in normal view, but it should be visible when viewing source. Added comment start/end delimiters just so we can see that we're not seeing what's inside them. Credit to the sevtech-ages repo for showing this technique to me.
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