Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better contribution docs, mention Gitter chatroom #253

Merged
merged 4 commits into from Apr 27, 2018

Conversation

Projects
None yet
1 participant
@latk
Copy link
Member

commented Apr 13, 2018

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.)

latk added some commits Apr 11, 2018

docs: improve CONTRIBUTING guide
- dependencies via requirements.txt
- clearer pull request guidelines
- mention AUTHORS.txt
- clarify flake8
- better project overview
docs: build Sphinx on Travis
This ought to fail if there are any problems with the documentation
link to the Gitter chat room
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.
@codecov

This comment has been minimized.

Copy link

commented Apr 13, 2018

Codecov Report

Merging #253 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa8e801...2c5a81f. Read the comment docs.

@latk latk merged commit e692552 into gcovr:master Apr 27, 2018

4 checks passed

codecov/patch Coverage not affected when comparing fa8e801...2c5a81f
Details
codecov/project 88.76% remains the same compared to fa8e801
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@latk latk deleted the latk:contribution-docs branch Apr 27, 2018

@latk latk removed the needs review label Apr 27, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.