Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Better contribution docs, mention Gitter chatroom #253
I dumped my experience from a few PRs into improved contribution docs. My goal is to clarify expectations around PRs, and make it easier to get started in a local development environment. For example, development requirements are now listed in the top-level
This PR also advertises a Gitter chatroom. Having a chat is desirable because informal real-time discussions are sometimes much more efficient than typing up issue comments. I tested this by walking a first-time contributor through Git and the pull request process.
Gitter is a chat service with good GitHub integration. The chat rooms are fairly open and can be viewed without having to log in. For logged-in users, there is an IRC bridge. Gcovr developers (i.e. anyone with push access to this repo) are automatically admins in the chatroom.
While I was already working on the docs, I also added the documentation build process to Travis. This should help validate any documentation changes, since the GitHub preview is insufficient to render Sphinx documents. I also made the quick links on the documentation frontpage more compact.
(A quick note on my plans regarding the gcovr website: once this PR is merged, I want to switch the gcovr website to the sphinx documentation version, even though it will document the state of the gcovr development version and not the 3.4 release. I'll then try to figure out automatic deployment. Once Read The Docs supports HTTPS for custom domains, I'd like to migrate there to get multi-version documentation.)
@@ Coverage Diff @@ ## master #253 +/- ## ======================================= Coverage 88.76% 88.76% ======================================= Files 13 13 Lines 1477 1477 Branches 267 267 ======================================= Hits 1311 1311 Misses 108 108 Partials 58 58