Instructions for Editing Metadata-Related Configurations in GitHub

Owned by Cat Lu (Unlicensed)
Last updated: Feb 04, 2016
2 min read

Full list of files:

  • config/authorities/ directory (currently contains only languages.yml) [Warning: edits/deletions (but not additions) may need data migration]
  • config/locales/en.yml (changing the label of a field, also the tooltips are in here)
  • config/initializers/sufia_amendments.rb [Warning: edits/deletions (but not additions) may need data migration]

 

Current instructions (for submitting a pull request directly in the master branch of chufia):

  1. Navigate to relevant config file listed above in chemheritage/chf-sufia repo.
  2. Click on pencil icon to edit.
  3. Fill out a commit message below the file. It should start with a capital letter and sound like a present-tense command (e.g.: 'Add tooltip for inscription field').
  4. Select radio button for creating a new branch for commit and submitting as a pull request (you can name the branch or not as you prefer). Click button that says "Propose file change."
  5. On the next page click "Create pull request."
  6. You'll then see your pull request! Leave for Anna to review and merge.

 

Old instructions (here for documentation):

  1. click the 'fork' button anywhere in the chemheritage/chf-sufia project. select your own user account to fork the project there.
  2. once it's finished, you'll see you are looking at a fork of the project under your username. navigate to the file which is config/locales/en.yml
  3. You'll see some action buttons to the right just above the text of the file. click the little pencil to edit.
  4. make your changes.
  5. Below the file, fill out a commit message. It should start with a capital letter and sound like a present-tense command (e.g.: 'Add tooltip for inscription field') -- The commit message basically reads as if it completes the sentence "I want to ___ so I will apply this commit."
  6. It's always best practice to submit your change as a pull request, so select that radio box. and then submit (you can name the branch or not as you prefer).
  7. on the next page click "create pull request"
  8. You'll then see your pull request! It's probably not a bad idea to mention to me that you've done this -- at least until I make sure any notifications are coming through effectively.

 

Relevant links:

https://github.com/chemheritage/chf-sufia/issues/90

https://github.com/chemheritage/chf-sufia/issues/107