From c8c51b573bd9624727b8ee26dd7dc0c85da975bf Mon Sep 17 00:00:00 2001 From: Hugh Rundle Date: Mon, 18 Jan 2021 10:29:48 +1100 Subject: [PATCH] add contributing file Fixes #5 --- contributing.md | 31 +++++++++++++++++++++++++ website/contributing.html | 48 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 contributing.md create mode 100644 website/contributing.html diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..7bbcd9b --- /dev/null +++ b/contributing.md @@ -0,0 +1,31 @@ +## 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 + +1. You can [create an issue](https://github.com/hughrun/public_library_map/issues) on GitHub. +2. You can [send a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) — though it is *strongly preferred* that you either ask to be assigned to an existing issue, or create a new issue, first. +3. You can just send an email to `librarymap`@`hugh`.`run` + +### 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. + +### 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! \ No newline at end of file diff --git a/website/contributing.html b/website/contributing.html new file mode 100644 index 0000000..2c1b807 --- /dev/null +++ b/website/contributing.html @@ -0,0 +1,48 @@ + + + + + + + Contributing - Library Map + + + + +
+
+ +

Contributing to Library Map

+

Beta!

+
+
+ +
+

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

+
    +
  1. You can create an issue on GitHub.
    2. +
  2. 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.
    3. +
  3. You can just send an email to librarymap@hugh.run
    4. +
+

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.

+

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!

+
+ + \ No newline at end of file