Skip to main content

How to contribute

We deeply appreciate your interest in contributing to the Canvas Editor project. Your valuable contributions play a pivotal role in enhancing this project. Before you begin, please take a moment to review the following guidelines.

Table of Contents​

Getting Started​

  1. Initiate the process by downloading the installer for the Long-Term Support (LTS) version of Node.js. This step also facilitates npm installation.
  2. Proceed by forking the react-canvas-editor repository.
  3. Execute npm install to install the required dependencies for this package.
  4. Gain 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. Establish a new branch within your forked repository, providing it with a descriptive name.
  2. Implement the desired feature or rectify 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. Furnish 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 sustain 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 Canvas Editor project!