Update README with new badge and a revised contributing section #58

Stargator · 2017-10-08T14:50:48Z

exercism/dart now has a Chat Room on Gitter

I just created a chat room. You can visit it here: https://gitter.im/exercism/dart.

This pull-request adds this badge to your README.md:

If my aim is a little off, please let me know.

I figured a gitter room would be easier than a discussing in random pull requests or issues.

PS: Click here if you would prefer not to receive automatic pull-requests from Gitter in future.

devkabiir · 2017-10-08T18:39:39Z

@Stargator, I think, since we're already on Readme.md why not add a 'contributing' section, maybe a 'setup/requirements' too. And make this pull request about updating the Readme.md rather than just adding a gitter badge (it's perfectly aligned 👌), rename the PR too.

devkabiir

I'm approving because if you decide to create a separate PR for the Readme.md itself. See my comment.

Stargator · 2017-10-08T19:28:58Z

@kabiir We have a contributing section, which does need some work. So I'm including that.

Let me know if you think anything is missing. @fwip the same goes to you, if you so desire.

devkabiir · 2017-10-08T19:34:00Z

README.md

@@ -55,7 +55,7 @@ Please keep the following in mind:

 - All the tests for Dart exercises can be run from the top level of the repo with ... Please run this command before submitting your PR.


I suggest adding the command for running all tests.

devkabiir · 2017-10-08T19:38:59Z

README.md

@@ -35,7 +25,17 @@ Test files should use the following format:
 # include the body of an example test


Either we need to come up with a generalized example or perhaps use the hello-world exercise test.

Good catch, the standard practice is to use the Hello World

Stargator · 2017-10-11T01:27:49Z

Recommend adding details about the updates to "create-exercise". I'll try and get that this weekend.

rafaelalvessa · 2017-10-11T18:56:12Z

README.md

+  test("says hello world with no name", () {
+    final String result = helloWorld.hello();
+    expect(result, equals("Hello, World!"));
+  }, skip: false);


What's the purpose of this skip: false? The default behavior is not to skip a test, so this is redundant.

Hm. My thinking is that skip: false made it more clear to a user how to enable the other tests (change true to false). But deleting , skip: false is also possibly obvious.

How do other tracks handle this? Is there a consensus or established wisdom?

The automated testing switches this flag to true and then back to false after testing. Although I don't understand its purpose either.

It's so users focus on one failing test versus being told all the tests are failing.

Users are meant to solve the exercise one test at a time.

Now it's true, the skip: false doesn't need to be there, if that's what people were confused about.

@Stargator Ah, I see what you mean. Initially, users will skip all tests but the first one, and work their way through each test individually, to get them used to TDD. Alright, that sounds good to me.

rafaelalvessa · 2017-10-11T18:59:52Z

README.md

+    * `bin/configlet lint .` - Checks the config.json for formatting issues
+    * `bin/configlet fmt .` - Formats the config.json
+    * `bin/check_formatting` - Checks All the Dart files for formatting issues
+    * `pub run dart_style:format -l 120 -w .` - Formats all the Dart files


All these commands could potentially be put into a script to save some time.

Created a ticket to address that: #61

fwip · 2017-10-12T21:40:08Z

README.md

@@ -68,9 +76,11 @@ Please keep the following in mind:
 - Please do not add a README or README.md file to the exercise directory. The READMEs are constructed using shared metadata, which lives in the
 [exercism/problem-specifications](https://github.com/exercism/problem-specifications) repository. Further explanation can be found in [fixing-exercise-readmes](https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md)


I think this section is out of date - we should add README.md now, if I'm understanding correctly.

See: exercism/meta#15

Interesting, I read this as the "exercises" directory shouldn't have a README.

But each exercise should have a README like raindrops.

Okay, so it should be suggested to generate a README file using configlet. There's a issue created to update create-exercise to do this as well.

I'll update the README to make it clear the READMEs should be generated.

Stargator · 2017-10-14T15:46:47Z

@kabiir and @fwip Ready for you to re-review :)

Stargator · 2017-10-15T16:04:23Z

Given our agreement on using Rebase, reminder for me to update the README to include that Rebasing is our merge strategy for Pull Requests.

Given that, it would be prudent of us to also review the commit messages themselves to ensure they don't contain anything offensive or sensitive.

Stargator · 2017-10-15T20:38:44Z

Will merge once build is complete

* Add section about our merge strategy * Revise "Watch out" section

Stargator added this to the LaunchPad milestone Oct 8, 2017

Stargator self-assigned this Oct 8, 2017

devkabiir approved these changes Oct 8, 2017

View reviewed changes

Stargator changed the title ~~Add Gitter Badge to README~~ Update README with new badge and a revised contributing section Oct 8, 2017

devkabiir suggested changes Oct 8, 2017

View reviewed changes

Stargator force-pushed the gitter branch from d269b12 to 0c4d35c Compare October 10, 2017 02:09

Stargator modified the milestone: LaunchPad Oct 10, 2017

rafaelalvessa reviewed Oct 11, 2017

View reviewed changes

fwip approved these changes Oct 12, 2017

View reviewed changes

fwip suggested changes Oct 12, 2017

View reviewed changes

Stargator force-pushed the gitter branch from 0c4d35c to 4e20d42 Compare October 14, 2017 04:10

Stargator mentioned this pull request Oct 14, 2017

Create scripts to to reduce commands used to validate Pull Requests #61

Closed

devkabiir approved these changes Oct 15, 2017

View reviewed changes

Stargator added the high-priority label Oct 15, 2017

fwip approved these changes Oct 15, 2017

View reviewed changes

rafaelalvessa approved these changes Oct 15, 2017

View reviewed changes

Stargator force-pushed the gitter branch from 71a8aee to 925ad2c Compare October 15, 2017 20:38

Stargator added 6 commits October 15, 2017 16:51

Add Gitter Badge to README

aadeb9b

Revise contributing section

0099f92

Add example test

4106a70

Add commands to run

8e8b47e

Update README based on suggestions

6e299a7

Move Contributing section to separate file

a8637fe

* Add section about our merge strategy * Revise "Watch out" section

Stargator force-pushed the gitter branch from 925ad2c to a8637fe Compare October 15, 2017 20:51

Stargator merged commit d40b1bf into exercism:master Oct 15, 2017

Stargator deleted the gitter branch October 15, 2017 21:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README with new badge and a revised contributing section #58

Update README with new badge and a revised contributing section #58

Stargator commented Oct 8, 2017

devkabiir commented Oct 8, 2017

devkabiir left a comment

Stargator commented Oct 8, 2017

devkabiir Oct 8, 2017

Stargator Oct 8, 2017

devkabiir Oct 8, 2017

Stargator Oct 8, 2017

Stargator commented Oct 11, 2017

rafaelalvessa Oct 11, 2017

fwip Oct 11, 2017

devkabiir Oct 11, 2017

Stargator Oct 12, 2017

rafaelalvessa Oct 12, 2017 •

edited

Loading

rafaelalvessa Oct 11, 2017

Stargator Oct 14, 2017

fwip Oct 12, 2017

Stargator Oct 13, 2017

Stargator Oct 14, 2017

Stargator commented Oct 14, 2017

Stargator commented Oct 15, 2017

Stargator commented Oct 15, 2017

		@@ -55,7 +55,7 @@ Please keep the following in mind:

		- All the tests for Dart exercises can be run from the top level of the repo with ... Please run this command before submitting your PR.

		@@ -35,7 +25,17 @@ Test files should use the following format:
		# include the body of an example test

		@@ -68,9 +76,11 @@ Please keep the following in mind:
		- Please do not add a README or README.md file to the exercise directory. The READMEs are constructed using shared metadata, which lives in the
		[exercism/problem-specifications](https://github.com/exercism/problem-specifications) repository. Further explanation can be found in [fixing-exercise-readmes](https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md)

Update README with new badge and a revised contributing section #58

Update README with new badge and a revised contributing section #58

Conversation

Stargator commented Oct 8, 2017

exercism/dart now has a Chat Room on Gitter

devkabiir commented Oct 8, 2017

devkabiir left a comment

Choose a reason for hiding this comment

Stargator commented Oct 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Stargator commented Oct 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafaelalvessa Oct 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Stargator commented Oct 14, 2017

Stargator commented Oct 15, 2017

Stargator commented Oct 15, 2017

rafaelalvessa Oct 12, 2017 •

edited

Loading