Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Latest commit

 

History

History
46 lines (33 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 3.79 KB
Raw

Contributing to Draft-js-wysiwyg

If you're reading this, you're awesome! Thank you for helping us make this project great and being a part of the Draft-JS-Wysiwyg community. Here are a few guidelines that will help you along the way.

Code of Conduct

Draft-js-wysiwyg has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Types of contributions 📝

You can contribute to the Draft-js-wysiwyg content and site in several ways.

🚨 Issues

Issues are used to track tasks that contributors can help with. If an issue has a triage label, we haven't reviewed it yet and you shouldn't begin work on it.

If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.

🛠️ Pull requests

A pull request is a way to suggest changes in our repository.

To learn more about opening a pull request in this repo, see Opening a pull request below.

Starting with an issue

You can browse existing issues to find something that needs help!

Labels

Labels can help you find an issue you'd like to help with.

  • The help wanted label is for problems or updates that anyone in the community can start working on.
  • The good first issue label is for problems or updates we think are ideal for beginners.
  • The support label is for problems or updates that request for help with a concept or piece of code but this isn't an issue with the project.
  • The needs more info label is for problems or update with a misissing repro steps or context for both project issues & support questions.
  • The discussion label is for problems or updates where folks are discussing various approaches & ideas.
  • The documentation label is for problems or updates relating to improving documentation for the project.

Opening a pull request

  1. Fork the repo and create your branch from master.
  2. If you've added code that needs to be tested, you can add it yourself. Otherwise, we'll add the Needs test label to ask for help from other contributors to this project. This will surely lengthen the merging process.
  3. If you have changed the APIs, we would be grateful if you could update the documentation as well.
  4. Ensure the test suite passes using the yarn test command.
  5. Make sure your code lints using the yarn format command (and yarn docs:format command if you have modified the site doc).
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

License

By contributing to Draft-js-wysiwyg, you agree that your contributions will be licensed under its MIT license.