Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
A template to make good

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.


What things you need to install the software and how to install them

Give examples


A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example


Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds


Please read for details on our code of conduct, and the process for submitting pull requests to us.


We use SemVer for versioning. For the versions available, see the tags on this repository.


See also the list of contributors who participated in this project.


This project is licensed under the MIT License - see the file for details


  • Hat tip to anyone who's code was used
  • Inspiration
  • etc

Thank you


Awesome template!
Thanks ... πŸ‘

GeorgeTaveras1231 commented Oct 2, 2016 edited

Awesome template!

You have a typo right underneath the installing section. It says Stay what the step will be.


ooh! good catch, fixed πŸ˜„

ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !




Thanks, just what I needed to help me write something short and clear.


Clear and complete. Thanks a lot!


Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites


Fixed! Thanks πŸ˜„

desfero commented Oct 20, 2016

thanks :)


Really nice! Thanks for this guidance!



fddm commented Nov 4, 2016

Excellent template! Thanks!

RCSM commented Nov 7, 2016 edited

Helped a lot, thanks πŸ‘

andresroberto commented Nov 17, 2016 edited

Thank you very much for this awesome template! πŸ‘




Awesome! Thank you!

44r0n commented Nov 27, 2016

So helpful! Thank you!


oh my GOD thanks a lot


Thank you!


Thank you! This helped me so much.


Thank you so much, really helpful for new developers.


Thank you!


Thanks a ton πŸ‘πŸ‘


Very useful. Thanks a lot!

ctlong commented Jan 4, 2017

Wonderful, thanks!




Thanks a bunch


Thanks for this


This is really cool. Thanks!

ldecamp commented Jan 30, 2017

Really cool template. Thanks.

8eni commented Feb 7, 2017

great template


Time saviour! thank you !


Thanks a lot!

hsjoihs commented Feb 13, 2017



Thank you!


Thank you! :)

nirodg commented Feb 19, 2017

Thank you, nice job!


Good one, provides quick help.

Borange commented Feb 22, 2017

Great job! Thanks!


Thank You! (:

bnzene commented Mar 4, 2017 edited

Thank you!


Perfect - thank you!


Thank you!


Thank you!


Thank you!!


Thanks man!


Thank you πŸ‘


Appreciate this greatly!

mrm8488 commented Mar 29, 2017



How could I fork it to use later?


Thank you for creating this wonderful template. This is very helpful for me.

sfauch1 commented Mar 29, 2017



Thanks !


Thanks. Great resource.
BTW typo under Installing. 'how' instead of 'have'.

LappleApple commented Apr 1, 2017 edited

+1. Will add this to our/Zalando's own how-to as an alternate resource to this template.


thanks a lot nice temp

Josica commented Apr 5, 2017

Thank you!




Thanks so much for sharing this template. It is exactly what i need for the current project that I am working on. I will certainly tweak it a little but otherwise this is a good starting point.


I think it would it be interesting to add a changelog section, optional of course. In this section, there would be the additions sorted by releases but also the deprecated features. What do you think?


Great, thank you.


<3 <3 <3


This is exactly what I needed, thank you! <3


Perfect! Thank you.


Love it <3


Thank a lot ! Good template.


Thank you man. it's very usefull πŸ‘

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