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

Merge pull request #21 from hughrun/contrib

Browse source 
update contributing guide
This commit is contained in:
Hugh Rundle 2021-01-24 17:33:42 +11:00 committed by GitHub
parent ae5c04c533 08311866c6
commit 2beebe8099
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
contributing.md
View file

@ -8,6 +8,10 @@ I'd love your help to make *Library Map* as accurate and useful as possible.
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`.
### If you have not used Git or GitHub before
There is a class outline for an [introduction to Git and GitHub aimed at librarians](https://librarycarpentry.org/lc-git/) 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](https://docs.github.com/en/github/managing-files-in-a-repository/editing-files-in-another-users-repository), or use [GitHub Desktop](https://desktop.github.com/) - 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`

4
website/contributing/index.html
View file

@ -35,6 +35,8 @@
<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="if-you-have-not-used-git-or-github-before">If you have not used Git or GitHub before</h3>
<p>There is a class outline for an <a href="https://librarycarpentry.org/lc-git/">introduction to Git and GitHub aimed at librarians</a> at <code>librarycarpentry.org</code>. This assumes you are using the command line. If you create or already have a GitHub account, you can also <a href="https://docs.github.com/en/github/managing-files-in-a-repository/editing-files-in-another-users-repository">edit files directly in the browser</a>, or use <a href="https://desktop.github.com/">GitHub Desktop</a> - 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.</p>
<h3 id="which-files-to-update">Which files to update</h3>
<p>To update information about library <em>services</em> (e.g. fines info, loan period etc) you should edit <code>website/data/library_services_information.csv</code></p>
<p>To update information about library <em>locations</em> (e.g. street address, phone number, coordinates) you shoudl edit the relevant csv location file:</p>
@ -62,7 +64,7 @@
<h3 id="licensing-and-copyright">Licensing and copyright</h3>
<p>By contributing to this project you agree to license your work under the following licenses:</p>
<p><strong>/website/data/*</strong>: <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC-BY-SA</a></p>
<p><strong>everything else</strong>: <a href="https://www.gnu.org/licenses/gpl-3.0.txt">GPL-3.0-or-later</a></p>
<p><strong>everything else</strong>: <a href="https://www.gnu.org/licenses/gpl-3.0.txt">GPL-3.0-or-later</a></p>
</section>
</main>
<footer>