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

Latest commit

 

History

History
61 lines (37 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 2.03 KB

Contributing

Thank you for considering contributing to this project. Your help is very much appreciated!

When contributing, it's better to first discuss the change you wish to make via issue or discussion, or any other method with the owners of this repository before making a change.

All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.

Requirements

Note Due to the recent release, the modalities of contribution could change during the time.

In order to contribute and start the project locally, you can follow these 2 guides:

Run on your machine

Cloning the repository

To start contributing to the project, you have to fork this repository and clone it to your local machine:

git clone https://github.com/YOUR_USERNAME/codeimage.git

Installing dependencies

Once in the project's root directory, you can run the following command to install the project's dependencies:

pnpm install

Creating a new branch

Make sure you create a new branch for your changes. You can do this by running the following command in your terminal:

git checkout -b feat/my-feature

Run on Codesandbox Projects

You will be able to access the Project repository through this link:

https://codesandbox.io/p/github/riccardoperra/lexical-angular

You don't know CodeSandbox Projects?

CodeSandbox Docs

Pull Request Process

  1. We follow Conventional Commits in our commit messages, i.e. feat(core): improve typing
  2. Make sure you cover all code changes with unit tests
  3. When you are ready, create Pull Request of your fork into original repository