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

Issue 246 documentation: simple_math example #256

Open
wants to merge 19 commits into
base: master
Choose a base branch
from

Conversation

trbedwards
Copy link

I've created an example, simple_math, for demonstrating what happens when you have a non-zero mutation survival rate. I've also created a new directory 'examples' and corresponding section in the documentation. The docs for simple_math are linked to in the 'quick start' documentation.

@trbedwards trbedwards changed the title Issue 246 documentation Issue 246 documentation: simple_math example Oct 30, 2017
@abingham
Copy link
Contributor

This looks great! The only thing I think it needs is a mention that you can do the exercise from the examples/simple_math directory; it's not explicitly mentioned that we include this code in the repo. With that change it'll be good.

Also, can you squash all of the commits into a single commit for the PR? This isn't crucial, but it'll keep the master branch cleaner.

@trbedwards
Copy link
Author

Sure, I'll get this done today.

@trbedwards
Copy link
Author

I think I need to create a new pull request after squashing all my commits, I'll close this one

@trbedwards trbedwards closed this Nov 5, 2017
@trbedwards trbedwards reopened this Nov 5, 2017
@trbedwards
Copy link
Author

I'm having issues squashing the commits into one, do you simply use git rebase <old_commit>?

First commit of ten-pin bowling game example for test run.

Implemented strike and spare scroing. Plus tests.

config.yml file cosmic-ray run.

Improved the documentation for simple_math

More edits to the documentation
@trbedwards
Copy link
Author

I'll have another look at this on tuesday, I cocked up a bit with the squashing of the commits!

@abingham
Copy link
Contributor

abingham commented Nov 9, 2017

@trbedwards Sorry I didn't get back to you sooner; I was doing some intense traveling and missed this thread.

The basic approach to rolling a bunch of commits into one is "interactive rebasing". Suppose I'm on branch feature which is 10 commits ahead of master. Now suppose I want to squash all 10 of those commits into one commit, i.e. feature will then be just one commit ahead of master but with the equivalent aggregate change. You would run git rebase -i master and follow the instructions git gives you; the various "fixup" and "squash" options it shows you will get your history where you want it.

This can be a bit tricky the first few times, so you might want to read up on interactive rebasing a bit. It's also worth pointing out that once you do a rebase of feature you won't be able to (easily) push to and existing feature branch on another remote repo; you will have "changed history" from the remote repo's point of view.

I hope this all makes sense. Let me know if I can help out. I promise that knowing how to do interactive rebasing is a really powerful tool once you wrap your head around it!

Added .idea to gitignore and exluded directories in conf.py

Implemented strike and spare scroing. Plus tests.

config.yml file cosmic-ray run.

Improved the documentation for simple_math

More edits to the documentation
@trbedwards
Copy link
Author

@abingham I tried to do interactive rebasing, using git rebase -i master but I ended up running around in circles. I think commit ede7750 has everything squashed into it, but I don't know how to create a pull request for just that commit without all the messy history.

@abingham
Copy link
Contributor

Yep, it looks like ede7750 has all of the right contents. I think I can sort all of this out on my end, if you don't mind. I can just cherry pick that commit and merge it in, in all likelihood. The main downside is that it will look like my commit, not yours, in the git history. Are you ok with that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants