Hugh Rundle
883195cf83
- add instructions for updating CSV and not JSON - fix filepaths in merge_service_data.py - add info about license agreement for contributors - explain about large files that are currently missing Fixes #7 Fixes #15
3.7 KiB
Contributing
I'd love your help to make Library Map as accurate and useful as possible.
How to contribute your idea, bug report or improvement
- You can create an issue on GitHub.
- You can send a pull request — though it is strongly preferred that you either ask to be assigned to an existing issue, or create a new issue, first.
- You can just send an email to
librarymap@hugh.run.
Which files to update
To update information about library services (e.g. fines info, loan period etc) you should edit website/data/library_services_information.csv
To update information about library locations (e.g. street address, phone number, coordinates) you shoudl edit the relevant csv location file:
website/data/indigenous_knowledge_centre_locations.csvwebsite/data/mechanics_institute_locations.csvwebsite/data/nsla_library_locations.csvwebsite/data/public_library_locations.csv
Do not directly edit JSON files - these are updated programatically.
Citing and crediting data sources
If you are adding a lot of data and have a new source for it, make sure it is cited. You should update the list of sources at both sources.md and website/sources/index.html. If your source is "I just know because it's my local library" or "I looked it up on their website" you don't need to add that to the list of sources. If your source is "I found a PDF listing every public library on the State Library website", you do.
Missing or inaccurate data
Currently we're missing data for some library services in relation to standard loan periods and fines for overdue items.
It's likely that some library location data is inaccurate — especially for New South Wales. It's also possible that the address data is wrong (even though the location shown may be correct), and in some cases it is missing.
It's possible that some of the fines data for Queensland is a little off. This came from the State Library of Queensland but I know for a fact that some of the data was wrong (e.g. Gold Coast Libraries does not charge overdue fines, but the SLQ reports says it does).
I am particularly interested if you know of data sources for entire regions, states, or Australia — especially if they're reliably kept up to date.
If you can fill in any of these blanks, please update the relevant CSV file and send a pull request. If your data is coming from somewhere in particular, you should also add that to sources.md in the relevant table.
Ideas for additional data
You might have an idea for library data that would be useful to map. I'm really happy to hear about these ideas! It's possible that the information you want to map is unavailable, or just really hard to get, or maybe I will disagree that it's useful. That's ok - please ask anyway, expecially if you know where to find the data.
Improvements to documentation
I'm always — always — happy to hear how I can improve documentation. Even better if you make the edit and then send a pull request.
Improvements to the website design, layout, or information
You might have an idea for an improvement that's not about the data per se, but rather about the website. Maybe there's some accessibilty improvements I can make. Let me know!
Licensing and copyright
By contributing to this project you agree to license your work under the following licenses:
/website/data/*: CC-BY-SA
everything else: GPL-3.0-or-later