Create a community-wide contributing guide in the repository#26
Create a community-wide contributing guide in the repository#26oleg-nenashev merged 7 commits intomainfrom
Conversation
oleg-nenashev
added
documentation
| To do so, you can either fork and clone the repository and do edits in your branch, | ||
| or just use GitHub's web interface for small patches. | ||
|
|
||
| ### Built-in docs |
There was a problem hiding this comment.
Can I suggest we make this section more specific about the API documentation i.e. where it is and how to update it?
And also drop the ref to Javadocs, since we don't really do them at the moment. We should consider whether they're all that useful for a library like this, and if so fix them up a bit before encouraging contributions.
There was a problem hiding this comment.
@tomakehurst For Javadoc, we could agree to use https://javadoc.io/doc/com.github.tomakehurst/wiremock as the official location for now. Or I can quickly assemble publishing on https://wiremock.github.io/javadoc if we prefer to keep control in the community
There was a problem hiding this comment.
If you feel strongly that we really need them, then let's keep them somewhere under wiremock.org
There was a problem hiding this comment.
Created wiremock/wiremock.org#32 for the follow-up, will mention it from the doc
|
Aside from the above comments, LGTM. |
|
@tomakehurst addressed the comments, PTAL |
3 participants
The biggest chunk of #8. Other contributing guidelines like one in https://github.com/wiremock/wiremock will need to be updated to refer to this guide for generic sections.