Contributing

The contributions are more than welcome!
This project will be better with the open-source community help

There are no guidelines for now. This page will be updated in the future.

Steps to contributing

You will need GitHub account as well as git installed and configured with your GitHub account on your machine

Add the upstream repository using:

git remote add upstream git@github.com:singerdmx/flutter-quill.git

Open the project with your favorite IDE, we suggest using IntelliJ IDEA Community Edition
Sync the project with Gradle
Create a new git branch and switch to it using:
```
git checkout -b your-branch-name
```
The your-branch-name is your choice
Make your changes
If you are working on changes that depend on different library in the same repo, then in that directory copy pubspec_overrides.yaml.g which exists in all the libraries (flutter_quill_test and flutter_quill_extensions etc..) to pubspec_overrides.yaml which will be ignored by .gitignore and it will be used by dart pub to override the libraries
```
cp pubspec_overrides.yaml.g pubspec_overrides.yaml
```
or save some time and the following script:
```
./scripts/enable_local_dev.sh
```
Test them in the example and add changes in there if necessary
Mention the new changes in the CHANGELOG.md in the next block
Run the following script if possible
```
./scripts/before-push.sh
```
When you are done to send your pull request, run:
```
git add .
git commit -m "Your commit message"
git push origin your-branch-name
```
this will push the new branch to your forked repository
Now you can send your pull request either by following the link that you will get in the command line or open your forked repository, and you will find an option to send the pull request, you can also open the Pull Requests tab and send new pull request
Please wait for the review, and we might ask you to make more changes, then run:

git add .
git commit -m "Your new commit message"
git push origin your-branch-name

Thank you for your time and efforts to this open-source community project!!