parent
9c648c2cff
commit
a7579e8c62
17 changed files with 117 additions and 27 deletions
@ -1,3 +0,0 @@ |
||||
# Contributing |
||||
|
||||
We welcome contributions! |
@ -0,0 +1,56 @@ |
||||
# Contributing |
||||
|
||||
The contributions are more than welcome! <br> |
||||
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 |
||||
|
||||
1. Fork the repository in GitHub |
||||
2. clone the forked repository using `git` |
||||
3. Add the `upstream` repository using: |
||||
``` |
||||
git remote add upstream git@github.com:singerdmx/flutter-quill.git |
||||
``` |
||||
4. Open the project with your favorite IDE, we suggest using [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) |
||||
5. Sync the project with Gradle |
||||
6. Create a new git branch and switch to it using: |
||||
|
||||
``` |
||||
git checkout -b your-branch-name |
||||
``` |
||||
The `your-branch-name` is your choice |
||||
7. Make your changes |
||||
8. 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 |
||||
``` |
||||
10. Test them in the [example](../example) and add changes in there if necessary |
||||
11. Mention the new changes in the [CHANGELOG.md](../CHANGELOG.md) in the next block |
||||
12. 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 |
||||
13. 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](https://github.com/singerdmx/flutter-quill) tab and send new pull request |
||||
1. 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!! |
@ -0,0 +1,3 @@ |
||||
dependency_overrides: |
||||
flutter_quill: |
||||
path: ../ |
@ -0,0 +1,3 @@ |
||||
dependency_overrides: |
||||
flutter_quill: |
||||
path: ../ |
@ -0,0 +1,3 @@ |
||||
dependency_overrides: |
||||
flutter_quill_test: |
||||
path: ./flutter_quill_test |
@ -0,0 +1,20 @@ |
||||
#!/bin/bash |
||||
|
||||
echo "" |
||||
|
||||
echo "Disable local development for flutter_quill:" |
||||
rm pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_extensions:" |
||||
rm flutter_quill_extensions/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_test:" |
||||
rm flutter_quill_test/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Local development for all libraries has been disabled, please 'flutter pub get' for each one of them" |
@ -0,0 +1,20 @@ |
||||
#!/bin/bash |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill:" |
||||
cp pubspec_overrides.yaml.g pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_extensions:" |
||||
cp flutter_quill_extensions/pubspec_overrides.yaml.g flutter_quill_extensions/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Enable local development for flutter_quill_test:" |
||||
cp flutter_quill_test/pubspec_overrides.yaml.g flutter_quill_test/pubspec_overrides.yaml |
||||
|
||||
echo "" |
||||
|
||||
echo "Local development for all libraries has been enabled, please 'flutter pub get' for each one of them" |
Loading…
Reference in new issue