Contribute to MRjs

As an open-source project, there are many opportunities to participate in MRjs.

All work happens directly on GitHub. Both core team members and external contributors send pull requests, which go through the same review process.

Code of conduct

MRjs 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.

Help to report bugs

MRjs uses GitHub to manage bug reports and feature requests. It helps developers keep track of what is broken and who might fix it. Users can help our effort by making their bug reports clear and specific. The better your bug report, the easier it is to identify the cause, and fix the bug.

  1. Search the issue tracker for similar issues.
  2. Specify information about your browser and system (e.g., “Firefox Nightly on Fedora 39”)
  3. Describe the problem in detail (i.e., what happened and what you expected would happen).
  4. If possible, provide a small test case with CodePen, a link to your application, and/or a screenshot. You can fork this sample pen.

Provide feedback

You can also use the issue tracker to write feature requests, ideas, clarifications, and anything else that help us improve MRjs.

Contribute code to MRjs

Check out the issues labeled good first issue for good issues to tackle.

Here’s how to submit a Pull Request (PR):

  1. Have a GitHub account with SSH keys set up.
  2. Fork the repository on GitHub.
  3. Clone your fork of the repository locally (i.e., git clone [email protected]:yourusername/mrjs).
  4. Run npm install && npm run build to get dependencies and npm run server to serve the test examples.
  5. Create a branch to work in (i.e., git checkout -b mybranch).
  6. Introduce changes to your fork of the repository, commit them, and push them (i.e., git add -A . && git commit -m 'My Changes (fixes #1234)' && git push origin mybranch).
  7. If necessary, write unit tests. Model your tests after the loadModelsTesting setup and make sure to place them in the proper testing folder.
  8. Submit a pull request to the main branch. If you head to the MRjs repository after running git push from earlier, you should see a pop-up to submit a pull request.
  9. Address review comments if any.

As usual with open-source, you would agree to license your contributions under the MIT License.

Share your Work

  1. Create something awesome using MRjs.
  2. Publish your work online, so everyone can learn from it.
  3. Share it on Discord.
  4. Tell us about it so we can feature it on our blog.
  5. For bonus points, write and publish a case study to explain how you built it.

How to get in touch