CONTRIBUTING.md

Contributing to react-world-map

Thanks for your valuable desire to participate in this project!

Table of Contents

1. Setup and development
2. How to build code and view demo
3. Opening a PR
4. How to update version

Setup and development

1. Fork the repo and clone locally
2. npm install to get dev dependencies installed

Then:

• Edit src/index.tsx to make changes to the project

And / Or:

• Edit docs/index.jsx to make changes to the demo

How to build code and view demo

1. Build the code npm run build
2. Build the demo npm run build-demo
3. View the demo by opening docs/index.html in your browser
4. Test manually: click around on the map, check the console for errors, etc.

Opening a PR

• Use descriptive, imperative-tense commit messages and PR titles
• Use git rebase to organize your git history, if you have multiple "wip" commits
• Run npm run lint (or npm run lint-fix to autofix some errors) and npm run tsc to check your types and formatting
• Demo is tested and still works (see above)
• Readme and other relevant documentation is updated
• Update version (see below)

How to update version

1. Determine the type of version update using semantic versioning
2. Run npm version <major/minor/patch>
3. Add entry to CHANGELOG.md, and use git add CHANGELOG.md && git commit --amend (type :wq then hit "enter" key to escape vim) to include it in the npm version commit