License header for markdown

Open
#2,061 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
html, markdown, xml
Domain
documentation

Research direction

The issue names no files or tests, so begin by searching Spotless for license-header support and Markdown, HTML, or XML formatter entry points. Done means Markdown supports a license header inside an HTML comment, with equivalent placement rules for HTML/XML as described.

Written by the indexing model from the issue text.

Description

it'd be nice to support a license header for markdown; since documentation is very copyrightable. It'd be <!-- something --> This is also true of html/xml, though html/xml would have to be inside of the outer element.

Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.