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

New feature: names #23

Open
slothelle opened this issue Sep 15, 2017 · 3 comments
Open

New feature: names #23

slothelle opened this issue Sep 15, 2017 · 3 comments

Comments

@slothelle
Copy link
Owner

Summary

👋 your task, should you choose to accept it, is to add names (like, for people) to Cryptozoologist.

Acceptance criteria

  • As a user of the Cryptozoologist gem, I can call the method Cryptozoologist.name and be provided with a string that uses the internal dictionaries (of your choice) to make a person's name (Petunia Pygmy Puff, Samaria Aquamarine, Akari Jumpsuit)
  • As a user of the Cryptozoologist gem, I can find documentation in the README for how to use the new method
  • As someone curious about the Cryptozoologist gem, I can view the version bump for these changes in the CHANGELOG
  • As a contributor to the gem, I can run all of the tests and they pass!

Requirements

  • If you want to add a new dictionary, you can, but make sure you follow the current namespacing patterns
  • All new code should be tested, but I welcome in progress PRs for feedback on your code before you write tests (this is optional!)
  • Names should reflect multiple countries of origin but should all be expressed with characters that are unicode. Accented characters are ok, but if you choose to add them, note that this may cause problems for some users with their systems.
  • I am concerned that some name/animal or name/color combinations could be incredibly offensive and would like to avoid this. I'm not sure if the best approach is to filter words out of existing dictionaries with a blacklist or create new dictionaries that are only available for this method, or even remove those words from the dictionaries entirely. I haven't done a full audit of the word list recently and I'm happy to take this task on myself as a follow up if you're not sure how to approach it, or aren't comfortable.
  • If you want to use feminine, masculine, or non-gender coded names, that's ok. I'd prefer they be in separate dictionaries - an option to return a name from a specific category is nice to have here as well!
@PrimeTimeTran
Copy link
Contributor

Alright I'll do it =)

@PrimeTimeTran
Copy link
Contributor

PrimeTimeTran commented Sep 17, 2017

@feministy I'm having difficulty understanding what Pygmy Puff Aquamarine & Jumpsuit have in common. Mind elaborating...? I've gotten the first names to work but I don't understand what type of last names you want. lol
screen shot 2017-09-17 at 7 15 48 pm

@slothelle
Copy link
Owner Author

@PrimeTimeTran they're words from different dictionaries 😄

i'll take a peek at the PR when i have some time and leave you comments!

@slothelle slothelle modified the milestone: Very very long milestone name with tacos because why not Sep 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants