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.
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.
git clone https://github.com/(your-user-name)/markdown-reader.git
cd markdown-reader- Create a new branch
git checkout -b <new-branch>- Change the code
- Commit the changes
- Push
git push origin <new-branch>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.]
"""
