Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.29 KB

File metadata and controls

49 lines (36 loc) · 1.29 KB

Contributing to Markdown Reader

Thank you for your interest in contributing to Markdown Reader! We welcome contributions of all kinds, including bug reports, feature suggestions, pull requests, and documentation improvements.


About the Project

Markdown Reader is a clean and intuitive Markdown reader with real-time preview support, dark mode toggle, and drag-and-drop file opening. It is compatible with macOS and Windows desktop environments and built with pure Python and Tkinter.


How to Get Started

  1. Fork the repository fork
  2. Clone the repository
git clone https://github.com/(your-user-name)/markdown-reader.git
cd markdown-reader
  1. Create a new branch
git checkout -b <new-branch>
  1. Change the code
  2. Commit the changes
  3. Push
git push origin <new-branch>
  1. Create a pull request alt text

Code Documentation Guidlines

When creating or updating a .py function, please follow the following guidelines for documenting the function:

"""
[Description of what the function does.]

:param [dateType] [parameterName]: [Description of the parameter.]

:return: A [dataType] [description of the conditions for return.]

:raises [errorType]: If [description of the conditions to raise the error.]
"""