Team3 MarkdownDoc

Requirements

• Java 11
• IntelliJ 2020.2 (See the link for details.)

Supported Language: Java 11

How to run

Testing

To test the project, run gradle test. If errors occur, try gradle clean test.

Running

To run the project, run gradle runIde.

1. Make some JavaDoc.
2. Put "!!mdDoc" on the top of the comment.

/**
 * !!mdDoc
 * [content]
 */

1. The document is parsed.

Development Guidelines

Please adhere to the following guidelines:

1. Create a new branch, develop/<keyword>, before working on a new user story. Merge to master after testing completes.
2. Coding conventions
   1. Use camelCase for variables and methods.
   2. Use PascalCase for classes.
   3. A variable name should sufficiently explain the value it holds.
   4. Method names should start with a verb.
   5. Use 4 spaces for indents.
   6. Comment your code. Also, add javadoc comments to public methods.
   7. Explain public interfaces at wiki/API.
3. Git conventions

   1. Your git commit message must not be empty. Commit messages should have the following format:

      Write title
      
      Programmer programming programs.
      Coder coding codes.
      

      Title should start with a present-tense verb and end without a period.

      Description is optional. There should be an empty line between a title and a description.

   2. You must not rebase or force-push any remote branch.

      It alteres the Git history.

   3. Merge requests need at least 1 appoval and test coverage over 85% to be merged. Approving your own MR does not count.

      As squash merge alteres the Git history, you should not squash-merge.

Useful information

• The testData directory contains files for testing.
• For a footer and header of HTML, see src/main/resources. Footer has a JavaScript code for sorting.

Notes to developers

• CI runners are slow. The average time required for a pipeline to be completed is 6 to 15 minutes.
• Not all commits of master branch are deployable.
• The project uses 3rd party libraries.