From d2e3fc77fff7f5018f603d72e3d74e227b150866 Mon Sep 17 00:00:00 2001 From: Hugh Rundle Date: Thu, 28 Jan 2021 09:59:27 +1100 Subject: [PATCH] update contributing pages fixes #44 - make it clearer which issues to look at --- contributing.md | 7 ++++--- website/contributing/index.html | 9 +++++---- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/contributing.md b/contributing.md index ac27224..162e44e 100644 --- a/contributing.md +++ b/contributing.md @@ -4,9 +4,10 @@ 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`. +1. Look at the [current GitHub issues tagged `help wanted`](https://github.com/hughrun/public_library_map/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) to see if you can help. Most of these will be to do with updating data, like finding street addresses or other information. +2. You can [create a new issue](https://github.com/hughrun/public_library_map/issues) on GitHub. +3. 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 (so everyone knows you're working on it), or create a new issue, first. +4. You can just send an email to `librarymap`@`hugh`.`run` and ask me to fix/add something. ### If you have not used Git or GitHub before diff --git a/website/contributing/index.html b/website/contributing/index.html index c8b7a9a..81c4b1f 100644 --- a/website/contributing/index.html +++ b/website/contributing/index.html @@ -31,16 +31,17 @@

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. +
  4. Look at the current GitHub issues tagged help wantedto see if you can help. Most of these will be to do with updating data, like finding street addresses or other information.
    5. +
  5. You can create a new issue on GitHub.
    6. +
  6. You can send a pull request — though it is strongly preferred that you either ask to be assigned to an existing issue (so everyone knows you're working on it), or create a new issue, first.
    7. +
  7. You can just send an email to librarymap@hugh.run and ask me to fix/add something.

If you have not used Git or GitHub before

There is a class outline for an introduction to Git and GitHub aimed at librarians at librarycarpentry.org. This assumes you are using the command line. If you create or already have a GitHub account, you can also edit files directly in the browser, or use GitHub Desktop - both of which are probably less intimidating options if you don’t have any desire to learn how to use a command line/shell interface, or just want to make a single minor update.

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

After your Pull Request is merged, a GitHub Action will automatically create a second pull request that merges data from website/data/library_services_information.csv into website/data/boundaries.topo.json. Please do not edit the topo.json file directly.

-

To update information about library locations (e.g. street address, phone number, coordinates) you shoudl edit the relevant csv location file:

+

To update information about library locations (e.g. street address, phone number, coordinates) you should edit the relevant csv location file: