Contribution guide with git2r

[zkamvar]

I've created an Rmarkdown document to help with contributing via git2r. I'm thinking about rendering into a static markdown document so it doesn't run into problems with proxy errors. I'm attaching the rendered HTML and markdown files from my machine:
CWG2R.zip

We could include this guide as a link in CONTRIBUTING.md

Let me know what you think, @hlapp.

[hlapp]

Intentional that 6. follows after 2.? I know that it will be rendered correctly anyway, but it sticks out when looking at the Rmd.

[zkamvar]

It was originally 6, but then I moved it up and didn't bother changing it because I knew MD would take care of it.

[hlapp]

Awesome work, Zhian!

[zkamvar]

I've made the requested changes. Let me know if these work for you.

[hlapp]

Isn't they will automatically be updated in your pull request better put as your pull request will be automatically updated with them?

[hlapp]

One minor remaining comment (see commit comment), otherwise great! 👍

[zkamvar]

Done.

Sent from my iPhone

On Dec 18, 2015, at 11:48, Hilmar Lapp [email protected] wrote:

One minor remaining comment (see commit comment), otherwise great!

—
Reply to this email directly or view it on GitHub.

[stewid]

Great work 👍

It is possible to add the sessionInfo to the commit message with git2r using session = TRUE

library(git2r)
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)

## Config user
config(repo, user.name="Alice", user.email="[email protected]")

## Write to a file and commit
writeLines("Hello world.",file.path(path, "example.txt"))
add(repo, "example.txt")
c1 <- commit(repo, "First commit message", session = TRUE)

## View sessionInfo in commit message
summary(c1)

[zkamvar]

Great work 👍

It is possible to add the sessionInfo to the commit message with git2r using session = TRUE

Thanks! That's a good tip; I'll include it in an update.