Skip to content
This repository has been archived by the owner on Dec 31, 2020. It is now read-only.

Latest commit

 

History

History
32 lines (18 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 2.13 KB

MobX Contributor Guide

Welcome to a community of developers just like you, striving to create the best experience around MobX. We welcome anyone who wants to contribute or provide constructive feedback, no matter the age or level of experience.

Here are some ways to contribute to the project, from easiest to most difficult:

Issues

Reporting bugs

If you encounter a bug, please file an issue on GitHub via the repository of the sub-project you think contains the bug. If an issue you have is already reported, please add additional information or add a 👍 reaction to indicate your agreement.

Include in the issue a link to your reproduction. A couple of good options are a small Github repo or a CodeSandbox.

If you have a more complicated issue where it is helpful to run it locally, you can download CodeSandbox template and work on it and then commit to your GitHub repo.

Improving the documentation

Improving the documentation, examples, and other open-source content can be the easiest way to contribute to the library. If you see a piece of content that can be better, open a PR with an improvement, no matter how small! If you would like to suggest a big change or major rewrite, we’d love to hear your ideas but please open an issue for discussion before writing the PR.

Responding to issues

In addition to reporting issues, a great way to contribute to MobX is to respond to other peoples' issues and try to identify the problem or help them work around it. If you’re interested in taking a more active role in this process, please go ahead and respond to issues.

Small bug fixes

For a small bug fix change (less than 20 lines of code changed), feel free to open a pull request. We’ll try to merge it as fast as possible and ideally publish a new release on the same day. The only requirement is, make sure you also add a test that verifies the bug you are trying to fix.