commonmark / commonmark/commonmark-java

Java (OpenJDK) using commonmark-java

Open
#342 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
2.7k
Forks
336
PR merge metrics
No merged PRs in 30d

Description

Since this pull request, Java (OpenJDK) has included a copy of commonmark-java:

When they copied the source files, they made a few adjustments too. There's a list here:

// This module is primarily an import from a recent tagged version of
//     https://github.com/commonmark/commonmark-java
//
// The following parts are imported:
//
// * commonmark/src/main/java
// * commonmark/src/main/resources
// * commonmark-ext-gfm-tables/src/main/java
// * commonmark-ext-gfm-tables/src/main/resources
//
// For source and resource files, the following transformations are applied:
//
// * legal headers are added
// * package and import statements are updated
// * characters outside the ASCII range are converted to Unicode escapes
// * @SuppressWarnings("fallthrough") is added to getSetextHeadingLevel
// * the value for ENTITY_PATH is updated with the modified package
// * the file `entities.properties` is renamed to `entities.txt`

Let's make it easier for them next time by adopting some of the changes.

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.

Research direction

Start by comparing the commonmark/src/main/java and commonmark/src/main/resources paths, plus commonmark-ext-gfm-tables/src/main/java and src/main/resources, with the copied OpenJDK files referenced in module-info.java. Review each listed transformation and the related source and resource layout. Done means the relevant differences are addressed so a future OpenJDK import needs fewer adjustments.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.