Skip to content

Create stub template, change POLICIES.md/CONTRIBUTING.md#1723

Merged
FridaTveit merged 4 commits intoexercism:masterfrom
lemoncurry:template_stub
Sep 9, 2019
Merged

Create stub template, change POLICIES.md/CONTRIBUTING.md#1723
FridaTveit merged 4 commits intoexercism:masterfrom
lemoncurry:template_stub

Conversation

@lemoncurry
Copy link
Copy Markdown
Contributor


Reviewer Resources:

Track Policies

@lemoncurry
Copy link
Copy Markdown
Contributor Author

lemoncurry commented Aug 19, 2019

See #1721

Before adding the missing stub files, we should agree on the template.

@lemoncurry lemoncurry closed this Aug 19, 2019
@lemoncurry lemoncurry reopened this Aug 19, 2019
@lemoncurry lemoncurry closed this Aug 19, 2019
@lemoncurry lemoncurry reopened this Aug 19, 2019
@lemoncurry
Copy link
Copy Markdown
Contributor Author

The installation of jdk8 failed, so I had to update the travis config file and close/open the PR to trigger the builds.

See #1724.

@lemoncurry lemoncurry requested review from FridaTveit and Smarticles101 and removed request for FridaTveit August 19, 2019 07:41
@Smarticles101
Copy link
Copy Markdown
Member

(@lemoncurry as a maintainer you should be able to restart the build from here if you sign in with github)

Comment thread POLICIES.md Outdated
@lemoncurry
Copy link
Copy Markdown
Contributor Author

(@lemoncurry as a maintainer you should be able to restart the build from here if you sign in with github)

Thank you!

Co-Authored-By: Logan Stucki <logan@loganstucki.me>
Copy link
Copy Markdown
Contributor

@FridaTveit FridaTveit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I only have one minor comment 🙂

Comment thread POLICIES.md Outdated
Comment thread POLICIES.md Outdated
Stubs should include the following body:
`throw new UnsupportedOperationException("Delete this statement and write your own implementation.");`
> - Exercises of difficulty 5 or higher: provide a starter file without stubs (StubTemplate.java) and rename it, and either (1) add hints to the hints.md file (which gets merged into the README.md for the exercise) or (2) provide stubs as above for exercises that demand complicated method signatures.
> - Exercises of difficulty 5 or higher: provide a starter file without stubs (StubTemplate.java file provided [here](https://github.com/exercism/java/tree/master/_template/src/main/java)) and rename it, and either (1) add hints to the hints.md file (which gets merged into the README.md for the exercise) or (2) provide stubs as above for exercises that demand complicated method signatures.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I think this sentence is still a tiny bit confusing. Reading it I think it's not quite clear if you're meant to copy the provided file or create your own. Something like:

Exercises of difficulty 5 or higher: copy the StubTemplate.java file (provided [here](...)) and rename it, and either ...

might be more clear? 🙂 And maybe a sentence explaining what we'd like it to be renamed to could be useful? E.g. ... and rename it to fit the exercise. For example, for the exercise linked-list the file could be named LinkedList.java. That's probably obvious, but maybe better to add too much information than too little? 🙂

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's true, it's better to add more information. I added your suggestions.

Copy link
Copy Markdown
Contributor

@FridaTveit FridaTveit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks @lemoncurry! 😄

@FridaTveit FridaTveit merged commit f58ee6d into exercism:master Sep 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants