Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document guidelines for every field #255

Merged
merged 1 commit into from
Apr 5, 2020
Merged

Document guidelines for every field #255

merged 1 commit into from
Apr 5, 2020

Conversation

axelboc
Copy link
Collaborator

@axelboc axelboc commented Apr 4, 2020

With all the discussions that took place over the past few months, I thought it wise to add to the content guidelines for each field in CONTRIBUTING.md.

I wrote as much as I could, trying to remember all the decisions that we've made so far. I'm sure I've made a lot of mistakes and forgot some things. Please pick them apart 🔍 and don't hesitate to crush my feelings if you think something could be better written! ❤️

There's probably a bit of work to be done to apply these guidelines consistently in the deck (notably for capitals), and they'll probably have to be adjusted as we go. I'm still not a huge fan of having multiple capitals in the Capital field, so I'm down with any guideline we can write to avoid that... 😂

@axelboc axelboc added the chore Documentation, licenses, repository structure, dependency upgrades, etc. label Apr 4, 2020
@axelboc axelboc added this to the v3.3 milestone Apr 4, 2020
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@aplaice
Copy link
Collaborator

aplaice commented Apr 4, 2020

That's really clear and thorough, while still being maximally concise!

Should the case of duplicate country names (#212) — currently only Saint-Martin/Sint Maarten in French and Spanish be mentioned or is it too much of a tiny corner-case?

(I can't really think of any other potential omissions.)

@aplaice
Copy link
Collaborator

aplaice commented Apr 4, 2020

Shouldn't this:

In the very unlikely case that two countries share the same name in a given language,

be at the end of line 65, giving something like:

If the title of the Wikipedia article contains a parenthetical portion for disambiguation purposes, it must be removed, unless the disambiguation is needed in the deck — e.g. Saint-Martin (Antilles françaises) and Saint-Martin (royaume des Pays-Bas) in the French deck — in the very unlikely case that two countries share the same name in a given language.

@axelboc
Copy link
Collaborator Author

axelboc commented Apr 4, 2020

Woops, thanks! I simplified the paragraph a little (I think).

Copy link
Member

@ohare93 ohare93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scraped the bottom of the barrel in terms of review comments 😅 Looks good 👍

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Documentation, licenses, repository structure, dependency upgrades, etc.
Development

Successfully merging this pull request may close these issues.

None yet

3 participants