Overview

Interested in contributing to QMarkdown? Here’s how you can contribute:

Introduction

QMarkdown is free to use (MIT License) for anybody building a web-based product or website. The QMarkdown community is working to make it better. Contributors like you help make QMarkdown great! We are happy to see you here.

Contributions are not limited to code. We also encourage feedback, documentation, new design, and tools. And, we also encourage sponsorship, especially if you are using QMarkdown in a business endeavor.

All you need is a GitHub account to get started.

Working in the open

QMarkdown lives on GitHub. All work, discussion, issues, bugs, features, improvements, and comments happen right out in the open where everyone can see.

If you’re looking for something that we don’t have, or you notice something could be improved, you have two options:

  1. Open an issue for the request. We’ll review the issue and get back to you with next steps. If we decide the request should be part of our pipeline, we’ll add it to our roadmap. There are never timeline guarantees for requests, but we’ll do our best to give you an estimate.

  2. Begin the work yourself and contribute it back to QMarkdown. We appreciate completed contributions but also works-in-progress. You’re welcome to open an issue to surface your work and we’ll weigh in and help where we can.

Regardless of how you choose to contribute, we encourage you to open an issue as early as possible in the process.

If working with GitHub sounds like a lot, check out this free video series.

Innovation through collaboration

Please take time to read this excellent article.