Most of the exported functions are pretty simple, so we don't need a lot of words. But plain-language and consistent descriptions would be great.

We also need examples!

currently, running changes() on a file just repeats the same minimal information about line changes as when running it for the whole repo. Ideally, it would give the user a diff for that file.

git2r does return diffs for each file, but they're in some obscure format and it doesn't have a way of rendering them. It looks like that's something we'll have to do.

• Figure out package name
• Change the name of this remote repo
• change it in DESCRIPTION

Make a single-page cheat sheet, similar to:
http://rogerdudler.github.io/git-guide/files/git_cheat_sheet.pdf

Use the later package to send a regular reminder to users to record their changes to the repo.

Suggested structures are as follows:

record()

Could also call to a specific file?

record("file.R")

Alternative names for stage or commit?

Suggested structures are as follows:

changes()

Could also call to a spsicifc file?

changes("file.R")

Alternative names for status?

suggestion from the QAECO presentation of changes:

enable syncing with existing github repo.

Something like githug's git_init

• Describe motivation for the package
• Describe common pitfalls for beginners that this package tries to overcome

Need two functions -- one which clones a repo from existing online source and another which creates a new repo.

Suggested structures are as follows:

download_repo(remote="git@...")

Downloads an existing git repo from specified (existing remote) -- e.g. github.com:ropenscilabs/ozrepro.git

Alternative names for download are clone and fetch.

And

create_repo(path = getwd(), create_structure =TRUE)

initliases an entirely new repo at the specified path, with default the current working directory.
The create_structure argument determines whether we add some default structure to the project, including

• file .gitignore (and basic ignores
• X.Rproj (Rstudio project file)
• folders R, data, output and ignore (and in each a basic readme)

Alternative names for create are initialise and start.

suggestion from QAECO meeting.

Include option to show which files changed in a particular record.

A function that is called to detect repo,

e.g. via memoise

suggestion from the QAECO presentation of changes:

enable you to either change completely or add to an old record message.

Hello!

Reading through your package description, I was reminded of @spderosso research into Git usability: sdg-mit/gitless(.com > Research papers at bottom) & https://youtu.be/31XZYMjg93o (30min talk).

Because I found no mention of it here, or on the ROpenSci's blog I thought it's worth recommending.

Cheers :-)

Nick and I presented the current version to our group, and got lots of feedback.

People suggested that it would be useful to be able to add a message to retrieve, to record why you went back in time.

rollback() ?
rollforward()
go_to()

retrieve()

the roll functions will just let you look at different points, the retrieve function will go back to a particular point and make it the new head (equivalent of checkout, branch, commit).

We want function to reinstate the status of project at previous commit - taking that and placing it on top of current state. This is one way of achieving it, via a branch and merge.

First go back in time

git checkout 7c71ab1

Then make some changes. When you try to commit we discovered we're in detahced head
Then

git branch -b reinstate
git add --all
git commit -m "Message" 
git merge master -s ours -m "XXXX"
git checkout master
git merge --ff-only reinstate
git branch -d reinstate

Seamless of moving forward and back in history

For the sync() function to be usable, users need to have a github account and be able to log into it from Rstudio. We may want a git_setup() function that allows them to input their username and password.

I propose we use pkgdown to easily make a nice website, and put the main documentation on it.

https://github.com/ropenscilabs/ozrepro/blob/0d1b9b3913e9425071a337573149032d6e1addad/R/go_to.R#L11

To check out a commit that was n commits ago you can just use git checkout branch-name@{n}

That way the user only needs to specify how far they wish to go back, and doesn’t have to fuss with SHAs at all. Or am I overlooking something that makes the need to specify a SHA essential?

I think the same may apply to the revert() function? Much better if the user can just specify an integer index of how far back the wish to go.

We need to make sure git is available for the package to use.

I think git2r includes the libgit2 source, so should be standalone (though we'd need to check this).
However the current code makes a number of system calls to git, which will only work if git is installed and visible at the command line.

We could either automate installation of command line git or (preferably) implement the functionality we need in git2r and remove the system calls.

Created a new Project called Rtest (just for testing). And initialized with changes

create_repo("C:/Users/jonathan/Documents/Code/Rtest")

started version control project at C:/Users/jonathan/Documents/Code/Rtest
Error: The current working directory (C:/Users/jonathan/Documents/Code/Rtest) is not in the directory of this version control project.
You could do setwd("C:/Users/jonathan/Documents/Code/Rtest") to move back into the directory and rerun this function.

Then I did:

setwd("C:/Users/jonathan/Documents/Code/Rtest")

All seems ok and then created a new file and added to source control with:

record("added Rpres")

Error: The current working directory (C:/Users/jonathan/Documents/Code/Rtest) is not in the directory of this version control project.
You could do setwd("C:/Users/jonathan/Documents/Code/Rtest") to move back into the directory and rerun this function.

Then I do:

setwd("C:/Users/jonathan/Documents/Code/Rtest")

but keep gettinq the same error again, and again, and again.......

suggestion from QAECO meeting.

• checkRepo function
• get_repo() decision and possibly implementation.
• .cache environment
• ready function: does it exist?
• ...

@goldingn 👋 according to our recently created package curation policy this repo should now be transferred to either one of your personal accounts, or the ropensci-archive organization.

If you don't answer within one month, I'll transfer the repository to ropensci-archive, after which you could still email me to transfer the repo to a personal account.

Thank you!

If you navigate out of your repo, and remind_me is triggered, it throws an error.

• Improve description of what package does
• Decide who's author, who's creator (currently includes Diego Barneche, Daniel Falster, Nick Golding)
• Compile people's names and their emails

Suggestion from QAECO meeting.

Enable you to tag a record as especially important, and also searchable in the timeline.