Skip to content
This repository has been archived by the owner on Nov 10, 2023. It is now read-only.

Latest commit

 

History

History
83 lines (64 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

83 lines (64 loc) · 4.11 KB

We explicitly welcome contributions, comments, requests, and suggestions.

Contributing to WaypointsZA

The most important thing is that valuable contributions are incorporated, so even sending a quick message (via email, Signal, WhatsApp) to the maintainers with the precise details of your edit, is fine.

Having said that, nowadays, there are modern, better, tried and tested ways to incorporate your changes that, amongst other things, allow an audit trail of the provenance of the data.

In order of preference:

[preferred] Using git (and your GitHub account) to edit the CUP file:

One can edit the file on one's own editor from a git checkout (beyond the scope of this document), or on can edit waypoints immediately like this:

  1. Log in to GitHub.
  2. Click on ZA_Cape.cup file.
  3. Click on the pencil icon in the top right corner.
  4. Modify the file as necessary. Try to keep changes to a single operation or waypoint so that the change history is easily viewable.
  5. At the bottom of the page, write a quick summary of changes. E.g. "Deleted duplicate waypoint." and click "Propose changes".
  6. Click "Create pull request" (twice).
  7. A maintainer with write access to the master branch can then approve and merge changes.

For a more detailed step-by-step walk through, see Davis from Arizona's instructions here.

[preferred] Using Google Sheets (and your Google Account) to edit the WaypointsZA spreadsheet:

One can request Editor access to the WaypointsZA spreadsheet.

Using Google Sheets to comment on the WaypointsZA spreadsheet:

Anyone can comment on the WaypointsZA spreadsheet. Anonymous contributions will be ignored.

[last resort] Email the maintainers:

Send an email to [email protected] with your edits.

Our (CGC?) Policies

(Up for debate: please make your voice heard!)

  1. A WP SHOULD NOT be closer than 5 km to another one.
  2. A WP SHOULD be an easily identifiable ground feature (BGA Findability: Cat A, Cat B, etc.).
  3. It SHOULD NOT be a Cat G (BGA: "A GNSS Waypoint that does not have an identifiable ground feature. These points will only be agreed where a topographical feature marked on the OS maps is not available in the area in which the point is required.) BGA has 2 out of ~1380 WPs in this Cat G.
  4. WP descriptions SHOULD NOT duplicate information already contained in other fields. E.g. no duplicating WP Style (Turn point, Mountain Peak, etc.), primary runway length, name, etc.

Special, derived files will be made available (TODO) for glide computers that cannot cope with this normalisation, or have other capacity constraints.

Converting the waypoints between formats

CSV (spreadsheet) to CUP:

  1. Download the Google Sheet as a CSV file (and rename to something sane like ZA_Cape.cup.csv).
  2. Remove all Columns after K and save. I.e. keep only the first 11 columns (name,code,country,lat,lon,elev,style,rwdir,rwlen,freq,desc).
  3. Run: ./script/sanitise.py ZA_Cape.cup.csv ZA_Cape.cup to create the verified output .cup file. (Requires aerofiles: pip install aerofiles)
  4. Rename output file appropriately and commit, push, and publish.

CUP to KML (Google Earth):

  1. Run: gpsbabel -i xcsv,style=script/name_cup.style -f ZA_Cape.cup -o kml -F ZA_Cape.cup.kml (Requires GPSBabel: apt install gpsbabel)
  2. Import the KML file as a new layer on the Google Map layer.
  3. Rename, and delete the old layer.

Resources

  1. CUP file specification