ruby icon indicating copy to clipboard operation
ruby copied to clipboard

Things to be taken into account for the stub files

Open emcoding opened this issue 6 years ago • 3 comments

Prep for #541 Collection of things to take into considerations. Discussions welcome and preferably on Slack / track-ruby

  • [ ] Implementation
  • [ ] Comments in stub file:
    • not alienating for experienced devs,
    • avoid the term 'stub file'
  • [ ] Should the TDD instructions move to... somewhere? Or can they stay in the Readme?
  • [ ] This is an opportunity to add some scaffolding for writing instance methods instead of the current class methods, while the students still need to write one method only (because from a track anatomy point of view, we want to keep it to one line methods first).

emcoding avatar Aug 06 '19 14:08 emcoding

(Updated with correct commenting format)

# Write your code for the 'Hello World' exercise in this file. 
# Make the tests in hello_world_test.rb pass. 
# To get started with TDD, see the readme file in your Hello World directory.

class HelloWorld
  # your code here
end

emcoding avatar Aug 06 '19 14:08 emcoding

I believe the comment style of // is not valid for Ruby. We can use mult-line comments there, if that is preferable. But the file should be strictly valid Ruby.

kotp avatar Aug 06 '19 17:08 kotp

=begin
Write your code for the 'Hello World' exercise in this file. Make the tests in
hello_world_test.rb pass.

To get started with TDD, see the readme file in your
Hello World directory.
=end

class HelloWorld
  # your code here
end

kotp avatar Aug 06 '19 17:08 kotp

I'm closing this, as all exercises now have a stub file.

kytrinyx avatar Oct 12 '22 22:10 kytrinyx