Add definitions - Githubissues

sylwiavargas commented 4 years ago

Effective definitions are at the core of the dictionary. Our dictionary contains definitions that could easily be classified as "explain it like I'm 5". We are serious about this.

Before you contribute

Choose a word or words from Words in need of definitions section below.
In the comments below, express that you want to write a definition and specify which word/s.
✅ The easiest way to solicit different definitions is to ask someone who has learned these things recently. You can submit one PR per definition or a few definitions all at once — please contribute as much as as few as you wish!

🔥 MAKE SURE THAT YOUR DEFINITIONS:

are beginners-friendly;
do not contain confusing terms;
are written in plain English;
ideally, are funny and/or fluffy and/or kind and/or use an effective analogy;
actually reflect what the thing is;
align with our Code of Conduct;

✚ you can (but don't have to!) add a meme if there's one that connects to the term or your definition and a "read more" link if you know of any! If you are adding any, please read our guidelines for links and memes in this issue: #32

To Contribute

➡️ In order to contribute, please:

git checkout dev and git checkout -b yourName
open the seeds.rb file and add new definition in the last section in an alphabetical order, following the pattern:

your_name_as_a_variable = User.create!(first_name: "your name or username", password: "just write abc123")

name_of_the_variable_def = Definition.create!(
  user: your_name_as_a_variable, 
  approved: true, 
  content: "here goes your content", 
  word: check_the_words_variable_in_the_words_section, 
  technology: check_the_technology_variable_in_the_technology_section,
  read_more_url: "some url", 
  read_more_at: "here write the name of the page", 
  meme_url: "some url", 
  meme_alt_text: "the description of the meme"
)

, for instance:

eric = User.create!(first_name: "Eric", password: "abc123")

angry_squid_def = Definition.create!(
  user: foobar, 
  approved: true, 
  content: "'<%= %>': angry squid shoots ink or evaluates ruby code and prints", word: angry_squid, 
  read_more_url: "https://dev.to/sylwiavargas/which-erb-tag-should-i-use-53f1", 
  read_more_at: "Dev blog", 
  meme_url: "https://res.cloudinary.com/practicaldev/image/fetch/s--XEpd1g3r--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev-to-uploads.s3.amazonaws.com/i/qi9kko95vgpn0iknjaq0.png", 
  meme_alt_text:"a graphic erb cheatsheet for when to use erb tags or html. If code needs to be visible or return something you want to use the angry squid <%=", 
  technology: rails
)

Test your code by running rails db:seed
If your code does not generate new bugs, run git add ., git commit -m "adds definition", git push
Submit a PR to sylwiavargas:dev