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

Add section to CONTRIBUTING about how to source data #1820

Closed
matthewmayer opened this issue Feb 9, 2023 · 2 comments · Fixed by #1888
Closed

Add section to CONTRIBUTING about how to source data #1820

matthewmayer opened this issue Feb 9, 2023 · 2 comments · Fixed by #1888
Assignees
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone

Comments

@matthewmayer
Copy link
Contributor

Clear and concise description of the problem

It comes up fairly frequently e.g. on #1778 and #1699 that it's not clear how to source data for locales. Perhaps we could add a new section to CONTRIBUTING with some tips e.g.
https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md

Suggested solution

Add a section of tips, something like

  • Faker shouldn't contain copyrighted materials
  • Facts cannot be copyrighted, so for example if you are translating a finite known list of things like the names of chemical elements into another language, that's fine
  • But if you are compiling list of for example popular personal names or cities, don't copy directly from a single source (Wikipedia, 'most popular lists', government data sites etc) - as compiling a list of facts can be copyrighted https://en.wikipedia.org/wiki/Copyright_in_compilation
  • It's best to refer to multiple sources and use your own judgement/knowledge to make a sample list of data

Alternative

No response

Additional context

No response

@matthewmayer matthewmayer added the s: pending triage Pending Triage label Feb 9, 2023
@import-brain import-brain added c: docs Improvements or additions to documentation and removed s: pending triage Pending Triage labels Feb 10, 2023
@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug labels Feb 11, 2023
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Feb 11, 2023
@ST-DDT
Copy link
Member

ST-DDT commented Feb 11, 2023

Yes, it is always good to have documentation to refer to.
Do you wish to address this/create a PR for it?

@matthewmayer
Copy link
Contributor Author

Sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants