about_yml icon indicating copy to clipboard operation
about_yml copied to clipboard

Clarification needed for fields

Open melodykramer opened this issue 9 years ago • 2 comments

In public repos, we list the name and full_name of projects. In private repos, we list project and then name.

I think name in public repos is equivalent to name in private repos. I think full_name in public repos is equivalent to project in private repos.

Is there a reason two distinct attribute names exist, and if not, which is the correct one?

melodykramer avatar Jan 21 '16 18:01 melodykramer

This isn't limited to private repos.

The Developer about.yml file contains project and name - not name and full_name.

(https://github.com/18F/API-All-the-X/blob/18f-pages/.about.yml)

melodykramer avatar Jan 21 '16 19:01 melodykramer

Ah. @gbinal converted some project YAML files to .about.yml recently, and carried over the project field instead of changing it to full_name. We should make the change wherever we see it (and remind folks to run the command-line validator, and get our web-based validator up soon).

mbland avatar Jan 22 '16 14:01 mbland