Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Samples need some more love #215

Open
bartoszmajsak opened this issue May 2, 2014 · 3 comments
Open

Samples need some more love #215

bartoszmajsak opened this issue May 2, 2014 · 3 comments
Assignees
@bartoszmajsak
Labels
documentation enhancement

Comments

@bartoszmajsak
Copy link
Contributor

As the repository is growing I believe we need to take some care about how we structure and present the samples. I was thinking about following improvements:

  • Each concrete sample should have README file so when people browse the repository they should know what is the goal of a given module and what technologies (including testing) were used.
  • My**Impl is not really the most appealing strategy for the samples. Therefore I think we could either decide on the common model (eg. Beers ;)) or we leave it up to the sample creator, but with emphasis on giving something real instead of yet another My**Impl
@arun-gupta
Copy link
Contributor

All relevant points.

Do you want to document the guidelines in the README ?

@bartoszmajsak
Copy link
Contributor Author

Sure, would love to do that. Please assign this issue to me and I will take care of it.

@arun-gupta
Copy link
Contributor

Assigned the issue to @bartoszmajsak

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bartoszmajsak bartoszmajsak

Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@arun-gupta @bartoszmajsak