MetOffice / dm-dps-wmo-codes-registry

WMO Codes Registry Configuration
Apache License 2.0
1 stars 3 forks source link

content update | fix typo #16

Open marqh opened 8 years ago

marqh commented 8 years ago

In the < Contributing to codes.wmo > section

provide information on how to propose an update fixing a typographical change

marqh commented 8 years ago

If you notice a typo in the register, for example, you notice ‘velocity’ is spelled ‘vecolity’, this is how you can get it changed:

  1. The first step is to get the text so you can change it - so download the content in the RDF ttl-plain format.
  2. Open the file with a text editor, find the typo and fix all instances of it.
  3. Go to GitHub (you will need an account, and to be logged in) and go to https://github.com/wmo-registers/code-manuals/tree/master/typo_fixes
  4. Make a new file, using the ‘new file’ button.
  5. Name the file, ending in .ttl
  6. Copy and paste all the amended text into the new file.
  7. When you are proposing the new file, add an extended description so we know what you’ve changed.
  8. Hit the green ‘propose new file’ button.
  9. Review your change and hit the green ‘create pull request’ button.
  10. That’s it - thanks!
  11. Next up we’ll talk to our experts about the change you’ve suggested then evaluate it in our test system.
  12. We’ll get back to you through GitHub with an update to let you know what’s happening and if there’s further input we’d like from you.
6a6d74 commented 8 years ago

During IPET-MDRD-4 meeting, folks spotted a typo ... so I thought I'd try out your process to fix. At step (8) I had the option to 'commit direct to master' ... I guess that's because I've got commit privilege? Other than that, it was quite simple. I'll share this processing with folks tomorrow, time permitting.

For reference, see https://github.com/wmo-registers/code-manuals/pull/42

domlowe commented 8 years ago

Jeremy just demonstrated this - good work! I questioned whether instead of requiring download from the registry and upload of a new file whether it would be better to use the 'normal' github workflow directly on the .ttl files in github.

i..e find ttl file that is broken, fork > edit > pull request - discuss, merge

(if you try to edit a file you don't have access to github automatically offers to create a fork)