[[contributing]]
== Contributing

Spring REST Docs is intended to make it easy for you to produce high-quality
documentation for your RESTful services. However, we cannot achieve that goal without
your contributions.



[[contributing-questions]]
=== Questions

You can ask questions about Spring REST Docs on https://stackoverflow.com[Stack Overflow]
by using the `spring-restdocs` tag. Similarly, we encourage you to help your fellow
Spring REST Docs users by answering questions.



[[contributing-bugs]]
=== Bugs

If you believe you have found a bug, please take a moment to search the
{github}/issues?q=is%3Aissue[existing issues]. If no one else has reported the problem,
please {github}/issues/new[open a new issue] that describes the problem in detail and,
ideally, includes a test that reproduces it.



[[contributing-enhancements]]
=== Enhancements

If you would like an enhancement to be made to Spring REST Docs, pull requests are most
welcome. The source code is on {github}[GitHub]. You may want to search the
{github}/issues?q=is%3Aissue[existing issues] and {github}/pulls?q=is%3Apr[pull requests]
to see if the enhancement has already been proprosed. You may also want to
{github}/issues/new[open a new issue] to discuss a possible enhancement before work on it
begins.
