/book-study-refactoring

Book Study (Refactoring)

Read this in other languages: English, 한국어

📝 Goal

  • Getting knowledge about refactoring through a regular reading
  • Studying effectively by presentations
  • Getting various perspectives from others through discussions

🗓 Period

2022.10.31(Mon) - 2022.12.12(Mon) (7 weeks, OT in the first week)
1 or 2 weeks may be added depends on the process

❓ How to

  • Study 4 code smells every week (Total 24 code smells)
  • Conduct a presentation about a code smell (4 ppl a week)
    • Who presents what will be pre-announced
  • Make a pull request of examples and presentation by every Sunday 23:59:59
  • Presentations are given on 8pm every Monday
  • Posting and presentation can be written and conducted with a preferred language, either English or Korean
  • Please use English as much as possible for the terms

🖋 Writing a post

  • Format:

    • Presentation

      1. Explain about the code smell
      2. Describe the solution that author suggests(all the solutions are well-explained in the book)
      3. Pick an example under each refactoring method and describe (There are multiple examples per refactoring method)

    • Examples

      1. Create your own examples
      2. Post one example for one code smell (A code smell has could have a few refactoring methods and the refactoring methods have its own examples. If you want, you can create all examples for the refactoring methods)

  • Post your own example(3) only without 1 & 2, if you do not present the following week

  • Please leave references if you have any

  • Please make sure that the article is written in a plain language and easy to read

🔖 Review (Optional)

  • You will review others’ presentations in the week you don’t present
  • You can review the writing skills as well as technical aspects
  • Please respect the writer. There’s nothing wrong, it’s just different
  • If you have a better way to explain or reference, please leave it as well
  • Review is not only criticizing, but praising

💾 Rule of PR

  • Subject:

    [Name] <code smell topic>

(e.g. [Yongju] Mysterious name)

  • File Name:

    <subject>-<name>.md

(e.g. mysterious-name-yongju.md)

  • Please add a separate folder for images

🗣 Presentation

  • You will give a presentation for 15 to 20 mins (No more than 20 mins)
  • Q&A session will be conducted after every presentations

💰 Deposit

  • $30 will be submitted to the group leader
  • $5 will be deducted if you don’t post presentations or examples
  • $2 will be deducted if you are late to post an article
  • $5 will be deducted if you don't participate the weekly meeting(every Monday)
  • If the balance is all used, you cannot join the next study
  • The money gathered will be used for coffee at the last meeting or KDD operating cost
  • All remaining will be returned