Copy editing #13

Closed
wants to merge 3 commits into
from

Projects

None yet

3 participants

@xiongchiamiov

A few minor copy-edits to PHK's essays rants "Varnish Does Not Hash" and "What SPDY did to my summer".

@xiongchiamiov xiongchiamiov referenced this pull request in xiongchiamiov/xiongchiamiov.github.com Feb 25, 2013
Open

Build a better portfolio #5

@perbu perbu closed this Jun 12, 2013
@perbu
Member
perbu commented Jun 12, 2013

Merged.

@xiongchiamiov

f9784fe is not a merge. :)

You can actually merge directly with git:

git remote add ifixit git://github.com/iFixit/Varnish-Cache.git
git fetch ifixit
git merge origin/copy-editing

If you'd like to condense several commits into one, you can squash them together, or ask the submitter to do this.

Not only is this going to be a lot easier than copy+pasting diffs around, but it retains the commit date and author information - so commits I made 9 months ago show up as commits I made 9 months ago, rather than as a commit you made 2 weeks ago.

Also, if you guys aren't actively doing development on Github (which it appears you aren't), you should probably turn off pull requests and issues in the repo admin, and change the homepage link (or README) to include information on where people should instead send contributions.

@tfheen
Member
tfheen commented Jun 25, 2013

]] James Pearson

Also, if you guys aren't actively doing development on Github (which
it appears you aren't), you should probably turn off pull requests and
issues in the repo admin, and change the homepage link (or README) to
include information on where people should instead send contributions.

It's not possible to turn off pull requests, sadly. Bugs are already
turned off, and the README points to varnish-cache.org, so I'm not
really sure what more we can do.

Tollef Fog Heen
Technical lead | Varnish Software AS
t: +47 21 98 92 64
We Make Websites Fly!

@xiongchiamiov

It's not possible to turn off pull requests, sadly.

Huh, you're right. My mistake.

the README points to varnish-cache.org, so I'm not really sure what more we can do.

Perhaps, as an outsider, I can provide a useful viewpoint.

The README says:

Documentation and additional information about Varnish is available on
http://www.varnish-cache.org/

This does not explicitly indicate that contribution documentation is also there; my response, seeing that, is "well, but I already know about Varnish (I'm hacking on it, after all), so I don't need to go there.".

Compare this to, say, errbit's contributing section. It has a dedicated section in the README, and a list of steps to follow. A similar list for Varnish actually already exists on the contributing page:

  1. open a trac bug
  2. write a varnishtest case which exposes the problem. This speeds up bugfixing by several orders of magnitude.
  3. suggest a patch
    • in the trac bug
    • on varnish-dev

There's no reason that information shouldn't be bundled with the source itself.

If you'd like to keep the README lean and clean, another option I've seen is to include a CONTRIBUTING file, much like how installation instructions and the license are separated out.

The main thing is that since there is a github repository (that looks rather official), the default assumption is that contributing is done through github; if that's not the preferred method, you need to explicitly say so.

Having the repo description include the information that it is a mirror was a great choice, btw.

HTH.

@richo richo pushed a commit to richo/Varnish-Cache that referenced this pull request Mar 19, 2014
@perbu perbu copy-edits
varnish#13

by xiongchiamiov
f9784fe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment