🤝 Contribution Guide for Markdown Maestro

First off, thank you for considering contributing to Markdown Maestro! Your help is essential for keeping it great.

This document provides guidelines for contributing to the project. Please feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

How Can I Contribute?

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Markdown Maestro itself.

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Provide a clear description of the enhancement, including the motivation and use case.
  • Explain why this enhancement would be useful to most Markdown Maestro users.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.

Pull Requests

We love pull requests! Here's a quick guide:

  1. Fork the repo and create your branch from main.
  2. Set up your development environment by following the Getting Started guide.
  3. Make your changes. Adhere to the code style and conventions.
  4. Add or update tests if you've added code that should be tested.
  5. Ensure the test suite passes (npm run test). (Note: Test script to be configured).
  6. Make sure your code lints (npm run lint).
  7. Issue that pull request!

Branching Strategy

  • main: This branch contains production-ready code. All development should be done in separate branches.
  • Feature Branches: Create a new branch for each new feature or bug fix.
    • Good: feat/add-new-parser, fix/editor-rendering-bug
    • Bad: my-changes, new-stuff

Code Style

  • Follow the existing code style. We use Prettier and ESLint to maintain a consistent style. Run npm run lint to check your code.
  • Use TypeScript. All new code should be written in TypeScript.
  • Component Structure: Follow the pattern of creating small, reusable components. Use shadcn/ui components where possible.
  • Comments: Please add comments to your code where it's not self-explanatory.

Questions?

If you have any questions, feel free to open an issue and tag it with question. We're happy to help you get started!

Thank you for your contribution!