search

osmlab / name-suggestion-index

Canonical common brand names, operators, transit and flags for OpenStreetMap.
https://nsi.guide
BSD 3-Clause "New" or "Revised" License
629 stars 830 forks source link

Contributing documentation is confusing #9657

Open Venefilyn opened 2 weeks ago

Venefilyn commented 2 weeks ago

With contributing document it is not super clear of what needs to be done to for example get id autogenerated. In particular, it is in the wiki page hidden away and not in CONTRIBUTING.md as I would expect. Searching for this while you have cloned the repo shows nothing

Likewise, an explanation of the npm commands would be great to have in CONTRIBUTING.md no matter what is on the wiki

bhousel commented 1 week ago

Maybe? We don't really expect most users to be forking the repo and running the npm commands.
Most of our contributions are just from people who want to update a .json file.

The project wiki really does have all the info that anyone would need, and broken down by casual contributors vs maintainer stuff.

Venefilyn commented 1 week ago

To me it was just a bit confusing about adding an entry where id was available on all the existing entries. Felt like I needed to generate one but it wasn't clear where to get it from