Update CONTRIBUTING.md

1. Fix typo
2. Fix some steps
3. Correct the number order
pull/1518/head
Ellet 1 year ago committed by GitHub
parent b6b756535a
commit 905512e8e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 29
      doc/CONTRIBUTING.md

@ -8,7 +8,7 @@ This page will be updated in the future.
## Steps to contributing ## Steps to contributing
You will need GitHub account as well as git installed and configured with your GitHub account on your machine You will need a GitHub account as well as Git installed and configured with your GitHub account on your machine
1. Fork the repository in GitHub 1. Fork the repository in GitHub
2. clone the forked repository using `git` 2. clone the forked repository using `git`
@ -16,45 +16,44 @@ You will need GitHub account as well as git installed and configured with your G
``` ```
git remote add upstream git@github.com:singerdmx/flutter-quill.git 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/) 4. Open the project with your favorite IDE, usually, we prefer to use Jetbrains IDEs, but since [VS Code](https://code.visualstudio.com) is more used and has more support for Dart, then we suggest using it if you want to.
5. Sync the project with Gradle 5. Create a new git branch and switch to it using:
6. Create a new git branch and switch to it using:
``` ```
git checkout -b your-branch-name git checkout -b your-branch-name
``` ```
The `your-branch-name` is your choice The `your-branch-name` is your choice
7. Make your changes 6. 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..) 7. If you are working on changes that depend on different libraries 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 to `pubspec_overrides.yaml` which will be ignored by `.gitignore` and will be used by dart pub to override the libraries
``` ```
cp pubspec_overrides.yaml.g pubspec_overrides.yaml cp pubspec_overrides.yaml.g pubspec_overrides.yaml
``` ```
or save some time and the following script: or save some time with the following script:
``` ```
./scripts/enable_local_dev.sh ./scripts/enable_local_dev.sh
``` ```
10. Test them in the [example](../example) and add changes in there if necessary 8. 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 9. Mention the new changes in the [CHANGELOG.md](../CHANGELOG.md) in the next block
12. Run the following script if possible 10. Run the following script if possible
``` ```
./scripts/before-push.sh ./scripts/before-push.sh
``` ```
13. When you are done to send your pull request, run: 11. When you are done sending your pull request, run:
``` ```
git add . git add .
git commit -m "Your commit message" git commit -m "Your commit message"
git push origin your-branch-name git push origin your-branch-name
``` ```
this will push the new branch to your forked repository this will push the new branch to your forked repository
14. Now you can send your pull request either by following the link that you will get in the command line or open your 12. 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 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 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: 13. Please wait for the review, and we might ask you to make more changes, then run:
``` ```
git add . git add .
git commit -m "Your new commit message" git commit -m "Your new commit message"
git push origin your-branch-name git push origin your-branch-name
``` ```
Thank you for your time and efforts to this open-source community project!! Thank you for your time and efforts in this open-source community project!!

Loading…
Cancel
Save