hugh/public_library_map
hugh/public_library_map
1
Fork 0
Code Issues 9 Pull requests Actions Packages Projects Releases Wiki Activity

add contributing file

Browse source 
Fixes #5
This commit is contained in:
Hugh Rundle 2021-01-18 10:29:48 +11:00
parent 2fcb48c317
commit c8c51b573b
2 changed files with 79 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
contributing.md Normal file
View file

@ -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!

48
website/contributing.html Normal file
View file

@ -0,0 +1,48 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type">
<meta content="utf-8" http-equiv="encoding">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Contributing - Library Map</title>
<link rel="shortcut icon" href="logo.svg" type="image/x-icon">
<link rel="stylesheet" type="text/css" href="style.css">
</head>
<body>
<header>
<section id="title">
<a href="index.html"><img id="logo" src="logo.svg"/></a>
<h2>Contributing to Library Map</h2>
<p id="beta">Beta!</p>
</section>
</header>
<nav>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="sources.html">Acknowledgements</a></li>
<li><a href="https://github.com/hughrun/public_library_map">Code</a></li>
</ul>
</nav>
<section class="info-page">
<h2 id="contributing">Contributing</h2>
<p>I’d love your help to make <em>Library Map</em> as accurate and useful as possible.</p>
<h3 id="how-to-contribute-your-idea-bug-report-or-improvement">How to contribute your idea, bug report or improvement</h3>
<ol type="1">
<li>You can <a href="https://github.com/hughrun/public_library_map/issues">create an issue</a> on GitHub.</li>
<li>You can <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">send a pull request</a> — though it is <em>strongly preferred</em> that you either ask to be assigned to an existing issue, or create a new issue, first.</li>
<li>You can just send an email to <code>librarymap</code>@<code>hugh</code>.<code>run</code></li>
</ol>
<h3 id="missing-or-inaccurate-data">Missing or inaccurate data</h3>
<p>Currently we’re missing data for some library services in relation to <strong>standard loan periods</strong> and <strong>fines for overdue items</strong>.</p>
<p>It’s likely that some <strong>library location data</strong> 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.</p>
<p>It’s possible that some of the <strong>fines data for Queensland</strong> 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).</p>
<p>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.</p>
<h3 id="ideas-for-additional-data">Ideas for additional data</h3>
<p>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.</p>
<h3 id="improvements-to-documentation">Improvements to documentation</h3>
<p>I’m always — <em>always</em> — happy to hear how I can improve documentation. Even better if you make the edit and then send a pull request.</p>
<h3 id="improvements-to-the-website-design-layout-or-information">Improvements to the website design, layout, or information</h3>
<p>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!</p>
</section>
</body>
</html>