Better contribution docs, mention Gitter chatroom #253
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- dependencies via requirements.txt - clearer pull request guidelines - mention AUTHORS.txt - clarify flake8 - better project overview
This ought to fail if there are any problems with the documentation
Having a chat is desirable because 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.
latk
added
Type: Enhancement
needs review
Docs
Codecov Report
@@ 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 58Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
requirements.txt.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.)