Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 2.73 KB

Contributing to RichText

Thank you for your interest in contributing to RichText!

I've put together the following guidelines to help you figure out where you can best be helpful to the project.

Quick start

Table of Contents

  1. Types of contributions
  2. Ground rules & expectations
  3. How to contribute

Types of contributions

Currently, there's no specific documentation or style guide for the code. Therefore, it would probably be easier to create issues rather than pull requests.

However, there are still many ways you can contribute to RichText:

  1. Suggest new ideas on how to extend the editor: Request a new feature
  2. Suggest any update that would simplify the usage of the editor: Request a new feature
  3. Fix or suggest a fix for issues/bugs that occur: Submit a bug report

Ground rules & expectations

Before we get started, here are a few expectations (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project.
  • Before opening a pull request, please ensure that you are working on the latest version of RichText.
  • If you open a pull request, please ensure that your contribution works in all current browsers.
  • The minified versions of the updated files should as well be kept up-to-date.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:

  • If your contribution is minor, such as a typo fix, or self-contained, such as writing a translation, open a pull request.
  • If your contribution is major, such as a new guide, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Have a look at Quick start to directly open a new issue.