Thanks for taking the time to contribute!
PRs and bug reports are welcome, and we are actively looking for new maintainers.
Please open a discussion or feature request before starting to work on a new feature. That way we can make sure it fits well with the overall architecture and plans of the library.
Goals and PhilosophyIt would be great to have some level of support for most, if not all features of the Google Maps JavaScript API. "Some level of support" is intentionally a bit vague here: Balancing the amount of features included in this library with the effort needed to maintain it (and thus prevent it from decaying) is going to be an ongoing discussion. Features added to the library are permanent, and need a commitment to keep maintaining them, which is why adding features has to be considered carefully.
The focus will be on providing an extensible library of "low-level" abstractions that can be used to implement known and unknown use-cases of the Google Maps JavaScript API in a React application.
In a lot of cases – especially when a solution needs to have a lot of flexibility (implementing an Autocomplete component for example) and room for opinion (generally everything with a UI) – it is preferrable to provide a "reference implementation" with our examples that users can then copy and adjust to their needs.
Development ProcessThe default procedure for adding functionality to the library is as follows:
The main branch is the active development branch.
Building @vis.gl/react-google-maps
locally from the source requires a current version of node.js. We use npm to manage the dependencies.
git checkout main
npm install
npm run test
Running the full test suite:
Or just the unit-tests:
Pull RequestsAny intended change to the code base must open a pull request and be approved by the maintainers.
Generally speaking, all PRs are open against the main
branch, unless the feature being affected no longer exists on main.
Tests
npm run test
must be successful.Documentation
docs/api-reference
.docs/upgrade-guide.md
.docs/whats-new.md
.Description on GitHub
@vis.gl/react-google-maps
follows the Semantic Versioning guidelines. Steps for publishing releases can be found here.
vis.gl is part of the Urban Computing Foundation. See the organization's Technical Charter.
Technical Steering Committeereact-google-maps development is governed by the vis.gl Technical Steering Committee (TSC).
MaintainersMaintainers of react-google-maps have commit access to this GitHub repository, and take part in the decision making process.
If you are interested in becoming a maintainer, read the governance guidelines.
The vis.gl TSC meets monthly and publishes meeting notes via a mailing list. This mailing list can also be utilized to reach out to the TSC.
Code of ConductPlease be mindful of and adhere to the Linux Foundation's Code of Conduct when contributing to react-google-maps.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4