Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 5 KB

CONTRIBUTING.md

File metadata and controls

65 lines (51 loc) · 5 KB

Contributing

This project uses GitHub to track issues and manage our source code.

This project uses the JavaScript programming language.

This project uses the TypeScript programming language.

  • Check out the TypeScript Docs to learn more.
  • (It's a superset of JavaScript, so knowing that already will help you a lot).

This project uses Bun as our development environment.

  • Check out the Bun Docs to learn more.
  • (It's similar to other JavaScript tools like Node/Jest/Esbuild/Vite, so knowing any of those already will help you a lot).
  • Bun supports both JavaScript and TypeScript.

If you want to contribute to name-suggestion-index, you'll probably need to:

  • Install Bun
  • git clone name-suggestion-index
  • cd into the project folder
  • bun install the dependencies

As you change things, you'll want to bun run all to ensure that things are working. (This command just runs clean, lint, build, and test.)

You can also test the code in a local server:

  • bun start - then open http://127.0.0.1:8080/ in a browser.

It's also good to check on the dependencies sometimes with commands like:

  • bun outdated - what packages have updates available?
  • bun update --interactive - choose which updates to apply

Try to keep things simple!

Adding new entries

If a notable entity is missing from the Name Suggestion Index, you can add it manually to establish a preferred tagging. The project wiki has detailed instructions on how to add a brand, operator, flag, or transit network, but these are the essential steps:

  • Find the Wikidata page for the entity you want to add, or create a page for the entity if one doesn't exist.
  • If you're comfortable with writing code:
    • Clone (fork) the name-suggestion-index repository to your userspace.
    • Browse to the relevant category file inside the data folder. For example, in order to add a brand tagged as amenity=bank in OpenStreetMap, you would go to data/brands/amenity/bank.json.
    • You can use existing entries as a template for the entity you want to add. Feel free to copy an entry, and change the values of the copied entry to suit the new entity. Don't worry about making sure the entry is in the right place in the file, or providing an id for the entry - there is a build script that maintainers often run on the name-suggestion-index repository that takes care of both automatically.
    • Save your changes, and submit a pull request to the name-suggestion-index repository to include your changes.
  • If you're not comfortable with writing code:
    • Submit an issue with as many details as possible about the entity you'd like to add. This includes the name, Wikidata ID, OSM tag category, official website, etc. The more reference details you provide, the more likely it is that a maintainer will work on your request.

Modifying existing entries

If there is a problem with an existing entry, please let us know! You can edit the code yourself to correct the problem (see above for basic instructions), or you can submit an issue to bring the problem to the attention of the name-suggestion-index project maintainers. For more details, see the Contributing overview page on the project wiki.

Project contacts

If you have any questions or want to reach out to a maintainer, ping any of these folks:

We can be found in: