Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
92 commits
Select commit Hold shift + click to select a range
c5a98b4
Scaffold docusaurus
themisir Aug 5, 2021
131ec70
Configure and create sample docs
themisir Aug 5, 2021
7a2be9a
doc: Minor changes
themisir Aug 5, 2021
3e085c3
refactor: Separate docs and website related content from each other
themisir Aug 5, 2021
2c6569f
Add dart as code highlighting language
JaffaKetchup Aug 5, 2021
111f298
Fixed broken links
themisir Aug 5, 2021
ebbef9a
Fix import errors on example project
themisir Aug 5, 2021
1bedeff
Renamed getting-started.md to go.md
JaffaKetchup Aug 5, 2021
5f4bdd9
Basic tree structure complete
JaffaKetchup Aug 6, 2021
4eec0a5
Finished how-does-it-work.md
JaffaKetchup Aug 6, 2021
ebdab64
Removed 'more' from footer as it wasn't really useful anyome
JaffaKetchup Aug 6, 2021
c715ad4
Add new custom icons
JaffaKetchup Aug 6, 2021
cada63a
Finished controller.md
JaffaKetchup Aug 7, 2021
b970df8
Marker layer docs written
themisir Aug 10, 2021
d203b06
Finished polygon-layer.md
JaffaKetchup Aug 11, 2021
25834a7
Added information about performance and innacuracies to marker-layer.…
JaffaKetchup Aug 11, 2021
8d79c03
Added plugins list (list.md) - will contact plugin authors to ensure …
JaffaKetchup Aug 22, 2021
e67c7dd
Corrections
JaffaKetchup Aug 22, 2021
6eec8d0
Add and update some plugins
JaffaKetchup Sep 3, 2021
699d629
Merge branch 'master' into master
themisir Sep 5, 2021
1fc6c32
Add information about vector tiles
JaffaKetchup Sep 11, 2021
dfd109f
Make changes request by @greensopinion
JaffaKetchup Sep 12, 2021
12c527d
Finished polyline-layer.md
JaffaKetchup Sep 25, 2021
b21fb3f
Changed version numbers
JaffaKetchup Sep 25, 2021
845de6c
Fixed broken links
JaffaKetchup Sep 25, 2021
20c3b2f
Merge branch 'fleaflet:master' into master
JaffaKetchup Sep 25, 2021
6b1889a
Added some information about common errors (common-errors.md)
JaffaKetchup Oct 7, 2021
1ff4705
Mark an external plugin as deprecated (closes https://github.com/flea…
JaffaKetchup Oct 7, 2021
384af32
More Tile Server information
JaffaKetchup Nov 24, 2021
65ed3cf
Fix links to fix deployment
JaffaKetchup Dec 22, 2021
5638f4a
improvement: add missing API docs for public models
comatory Jan 12, 2022
cda274e
improvement: add missing API docs to bounds data model
comatory Jan 12, 2022
8c5f524
improvement: add missing API docs for gesture event models
comatory Jan 12, 2022
d6ecf3f
improvement: add missing API docs for marker layer classes
comatory Jan 12, 2022
84c9120
Merge pull request #3 from themisir/add-missing-public-api-docs
comatory Jan 12, 2022
a319282
feature: add specs to bounds data model
comatory Jan 12, 2022
fb1d06e
Merge pull request #4 from themisir/add-specs-for-utility-functions
comatory Jan 13, 2022
93c5aea
Merge branch 'fleaflet:master' into master
JaffaKetchup Jan 28, 2022
8b517b3
Merge branch 'fleaflet:master' into master
JaffaKetchup Jan 29, 2022
7301a30
Merge branch 'master' into fix-merge-conflicts
JaffaKetchup Jan 29, 2022
6255dca
Add new README and CONTRIBUTING
JaffaKetchup Jan 29, 2022
be60de9
Fix formatting
JaffaKetchup Jan 29, 2022
29a6eff
Merge 'fix-merge-conflicts' to 'master' (#5)
JaffaKetchup Jan 29, 2022
6e70986
Merge branch 'master' of https://github.com/fleaflet/flutter_map into…
JaffaKetchup Jan 29, 2022
d054542
Merge branch 'fleaflet-master'
JaffaKetchup Jan 29, 2022
44c0554
Merge branch 'fleaflet:master' into master
JaffaKetchup Jan 29, 2022
840941e
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Jan 29, 2022
5d076db
Merge branch 'fleaflet:master' into master
JaffaKetchup Jan 29, 2022
896e821
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Jan 29, 2022
0e66974
Merge branch 'fleaflet:master' into master
JaffaKetchup Jan 30, 2022
d7e136c
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Jan 30, 2022
34ab80d
Merge branch 'fleaflet:master' into master
JaffaKetchup Jan 30, 2022
e974898
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Jan 30, 2022
a87c6bb
Merge branch 'fleaflet:master' into master
JaffaKetchup Feb 1, 2022
057cc77
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Feb 1, 2022
3292fa0
Merge branch 'fleaflet:master' into master
JaffaKetchup Feb 4, 2022
b992d2b
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Feb 4, 2022
9aedb0c
Merge branch 'fleaflet:master' into master
JaffaKetchup Feb 20, 2022
e2b3a4d
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Feb 20, 2022
b1eee51
Added new community-maintained plugin
JaffaKetchup Feb 26, 2022
c3513f9
Merge branch 'fleaflet:master' into master
JaffaKetchup Feb 26, 2022
aab87fa
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Feb 26, 2022
c1ea2ad
Resolve merge conflicts
JaffaKetchup Mar 20, 2022
6e527c9
Resolve merge conflicts
JaffaKetchup Mar 20, 2022
d8423fa
Merge branch 'master' of https://github.com/fleaflet/flutter_map into…
JaffaKetchup Mar 20, 2022
6755071
Update top section of '/introduction/go' to match README updates
JaffaKetchup Mar 20, 2022
e2520bd
Add "DON'T INTERACT WITH master BRANCH" warning to README
JaffaKetchup Mar 20, 2022
2d0aedb
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Apr 8, 2022
3af663c
Fix conflicts (I hope)
JaffaKetchup Apr 8, 2022
47780d7
Merge branch 'master' of https://github.com/fleaflet/flutter_map
JaffaKetchup Apr 8, 2022
93cc04b
Merge branch 'master' into fix-merge-conflicts
JaffaKetchup Apr 8, 2022
6faa215
Merge 'fix-merge-conflicts' into 'master' (#8)
JaffaKetchup Apr 8, 2022
cca2e92
Update README.md
JaffaKetchup Apr 8, 2022
b68879b
Merge branch 'master' into fix-merge-conflicts
themisir Apr 9, 2022
7450014
Fix conflicts (hopefully)
JaffaKetchup Apr 10, 2022
7d8b9bb
Merge 'master' from 'flutter_map' into 'fix-merge-conflicts' (#11)
JaffaKetchup Apr 10, 2022
86e587d
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup Apr 10, 2022
7fac284
Convert absolute into relative imports in example app
JaffaKetchup Apr 10, 2022
fa83870
Merge branch 'fix-merge-conflicts' of https://github.com/fleaflet-doc…
JaffaKetchup Apr 10, 2022
5773885
Merge branch 'master' into fix-merge-conflicts
JaffaKetchup Apr 10, 2022
78f11a9
Update Docusaurus and dependencies
JaffaKetchup Apr 10, 2022
28d0307
Merge branch 'fix-merge-conflicts' of https://github.com/fleaflet-doc…
JaffaKetchup Apr 10, 2022
87dd264
Empty Commit To Trigger Deployment
JaffaKetchup Apr 10, 2022
e3f4a86
Removed unnecessary links and files
JaffaKetchup Apr 11, 2022
ee64248
Merge branch 'master' of https://github.com/fleaflet/flutter_map into…
JaffaKetchup Apr 19, 2022
35b5759
Update bounds documentation
JaffaKetchup Apr 19, 2022
33686e3
Added documentation for polygon labels
JaffaKetchup Apr 21, 2022
6736da5
Add `labelPlacement` option to Polygons page
JaffaKetchup May 8, 2022
2b261a3
Merge branch 'fleaflet:master' into fix-merge-conflicts
JaffaKetchup May 8, 2022
8a8aa68
Merge branch 'master' of https://github.com/fleaflet/flutter_map into…
JaffaKetchup Jun 7, 2022
3447b97
Merge branch 'fix-merge-conflicts' of https://github.com/fleaflet-doc…
JaffaKetchup Jun 7, 2022
c25523e
Update plugins list
JaffaKetchup Jun 7, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing

'flutter_map' is only as big and useful as it is because of contributors. You can see a [list of current contributors here](https://github.com/fleaflet/flutter_map/graphs/contributors), and there are currently [![GitHub PRs](https://img.shields.io/github/issues-pr/fleaflet/flutter_map.svg?label=Pull%20Requests)](https://github.com/fleaflet/flutter_map/pulls/), each potentially from a new contributor.

Therefore, your contribution would be greatly appreciated, so we've written a guide to help you contribute successfully:

## Rough Guide

**Do you think your contribution is essential to 'flutter_map'/useful to all users?**

If not, then creating a plugin might be a good idea. To do this, see the Plugins section in these docs: there is advice, starting templates and a few rules to bear in mind. Plugins are preferred when possible as they keep the base library lightweight and easy to understand.

If you think it might be, continue onwards.

**Is the contribution to fix a bug? Do you feel comfortable coding it yourself?**

If it is, and you are comfortable fixing it yourself, feel free to create an issue stating the bug, mentioning that you're working on fixing it. Then cleanly fork the main repository, and fix the bug. Make sure you only fix/add/remove what's necessary, as this helps to avoid breaking changes. If there is a quick and dirty fix, try not to use it unless the bug is a big one and might take time to fix otherwise.

If it isn't, open a discussion or an issue stating your request. It might be that other people have already found a way to do it. If people like the idea, and you are comfortable doing it yourself, cleanly fork the main repository. Instead of then working on the `main` branch, work in a new branch: this helps to avoid merge conflicts until the end of development. You may choose to then open a DRAFT pull request to signify that you are working on it. Make sure you only fix/add/remove what's necessary, as this helps to keep track of changes.

If you don't feel comfortable coding changes yourself, start a discussion or an issue.

**I've finished coding it. What's next?**

Make sure you thoroughly test your changes, and consider writing automated tests.

Then consider whether you need to write documentation. If you do, make sure you follow a similar format to all the other pages in these docs, and use correct spelling and grammar (consider getting a spell checker for Markdown). Then remember to change the documentation version at 'introduction/go'. Change the title of the grey box, the text version, and the link (to the newest migration page), but leave the dynamic badge and other text untouched. If no new documentation is needed, don't touch the grey box.

After that, check if you need to add a migration guide. This is only applicable if the change was a breaking change.

One last thing! Consider if you need to write examples for your changes. If it's a bug fix, you probably won't need to, unless an example also needs to be fixed. But if it's a feature addition, it needs an example, or at least the updating of an existing example. Make sure you test the example as well!

**Can I publish it yet?**

Yes! Open a PR (or take the existing PR out of draft stage), and link the issue that you opened.

Hopefully a maintainer will merge your changes quickly. Note that not every new merge will result in a new pub.dev release, so you may have to switch to using the [GitHub installation method](/introduction/go#from-githubcom) for your new features.

We appreciate your changes!
Loading