Skip to main content

How to Contribute

We genuinely appreciate your interest in contributing to the React Document Editor project. Your invaluable contributions play a pivotal role in enhancing this project. Before you embark on your journey, please take a moment to familiarize yourself with the following guidelines:

Table of Contents​

Getting Started​

  1. Begin by downloading the installer for the Long-Term Support (LTS) version of Node.js. This step also streamlines the npm installation process.
  2. Proceed by forking the React Canvas Editor repository.
  3. Execute npm install to install the necessary dependencies for this package.
  4. Acquire insights into the document editor's functionality by running npm run storybook.

Selecting an Issue or Feature​

Review the project's issue tracker and GitHub repository to identify open issues or features that align with your interests. If you can't pinpoint a specific task, do not hesitate to reach out to the project maintainers for guidance.

Making Changes​

  1. Create a new branch within your forked repository, providing it with a descriptive name.
  2. Implement the desired feature or address the identified issue within your branch.
  3. Adhere to the project's coding style and conventions to ensure consistency.
  4. If applicable, create tests to comprehensively cover the functionality you're introducing or modifying.

Submitting a Pull Request​

  1. Initiate a pull request (PR) on the primary project repository.
  2. Provide a clear and concise description of the changes within the PR.
  3. Elaborate on the issue you are addressing and outline the proposed solution.
  4. Be prepared to receive constructive feedback and engage in productive discussions.
  5. Adjust your code as necessary based on the feedback received.

Code of Conduct​

Kindly be aware that we uphold a code of conduct to maintain a positive and inclusive community. We urge you to thoroughly read and adhere to these guidelines during your participation in the project.

Licensing​

By contributing to this project, you consent to the licensing terms chosen by the project. Ensure you review the project's licensing file for detailed information.

We extend our gratitude for your contributions and eagerly anticipate your active involvement in the React Document Editor project!