Iteration 1 Progress Report

Iteration 1

• Due Date: ~ 2023.11.14
• Meeting: 2023.11.14 10:00 PM

Iteration 1 Objectives & What we have done

1. Set structure for our project (wiki, branching rule, development policy, roles, ...) (DONE)
2. Write user stories for basic feature. This can be extended. (DONE)
3. Set basic functions for InelliJ IDEA plugin (open markdown file, read from it, synchronization) (DONE)
4. Implement our features (TODO)

Confirm Out Project Topic & Details

• Topic: Development of "WYSIWYG Markdown Editor"
• Details:
  • Rendering:
    • File synchronization on converting tabs for raw file and editor view
    • Markdown <-> 5HTML Converter to Render and Update the file contents
  • Editor: Provide two tabs for edit
    • Raw File Tab: Show the raw contents of markdown file -> original view of markdown file in provided by Intellij
    • Editor Tab: Show the web view(HTML) of markdown file. We can edit where and when we click the contents of the view.

Development Policy

(more details at Development Policy)

Commit Policy

• Use appropriate commit headers in front of commit messages
• Clarify the issue number in front of commit header if the commit involves to the issue.

Branch Policy

• Use modified git flow.
• Use total 4 branches mainly. (main, develop, hotfix, feature)
• Feature branches will be used during implementation of each features.
• Branch names should be intuitive enough to recognize feature's behavior by it.

Commit Conflict Policy

• Basically use git rebase for the merging the features.
• Each merge should be conducted after the pull/merge request issued by developers.

Set up initial base codes for development

• Write basic gradle projects and commited them to repository.
• Publish development branch

Decide Features and Assign Features to Developers

Features

• GUI: Floating two tabs(raw markdown file view, editor view)
• File Synchronization: Synchronizing file on changing the tabs
• Markdown <=> HTML Converter: Convert markdown and html in both way
• Editor: Editor used to modify contents

Assignments

• Group 1 Members: Yonghwan Kim, Hawoo Jung, Hyeli Jeong

  Feature Name	# of Assigned Developer(s)	Developers
  GUI	1	Yonghwan Kim
  File Synchronization	2	Hawoo Jung, Hyeli Jeong

• Group 2 Members : Minsu Sun, Donghun Shin, Hyeonsik Ham

  Feature Name	# of Assigned Developer(s)	Developers
  MD -> HTML Converter	1	Minsu Sun
  HTML -> MD Converter	1	Hyeonsik Ham
  Editor	1	Donghun Shin

User Stroy

(more details at User Story)

• Expcted Speed: 1 unit/hour

Issue Number	Title	Actual	Estimated	Priority	Author
#6	[Open markdown custom editor](/User-Story/Open markdown custom editor)	3 units	4 units	1	Hyeli Jeong
#6	[Put content into custom editor](/User-Story/Put content into custom editor)	2 units	2 units	1	Hyeli Jeong
#6	[Apply CSS into custom editor](/User-Story/Apply CSS into custom editor)	1 units	2 units	1	Hyeli Jeong
#5	[Listen event when editor tab changed](/User-Story/Listen event when editor tab changed)	3 units	2 units	1	Hawoo Jung
#5	[Add listening when modifying files](/User-Story/Add listening when modifying files)	6 units	4 units	1	Hawoo Jung
#2	[Convert HTML to Markdown](/User-Story/Convert HTML to Markdown)		4 units	1	Hyeonsik Ham
#2	[Apply HTML to Markdown onFocus event](/User-Story/Apply HTML to Markdown onFocus event)		5 units	1	Hyeonsik Ham Donghun Shin
#3	[Convert Markdown to HTML](/User-Story/Convert Markdown to HTML)		4 units	1	Minsu Sun

Feedback

• Assign every team members at least one role per a period. (Additional roles beyond the template of professor has given are acceptable.)
• It is better to use test-driven implementations(developments). Try to write the tests before the implementations of features.
• It would be better to modulize the features and write user stories for the each of modules so that the combining the features will be easier.