Skip to content

DOC: CONTRIBUTING.md: Gold plating: syntax, punctuation, Markdown format... #5086

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

Merged
merged 1 commit into from
Oct 8, 2013

Conversation

westurner
Copy link
Contributor

...ting

@westurner
Copy link
Contributor Author

... I don't know how many times I've wanted to deep link to the EXCELLENT commit message tags section, which doesn't have its very own heading.

@jreback
Copy link
Contributor

jreback commented Oct 2, 2013

can you squash?

@jtratner
Copy link
Contributor

jtratner commented Oct 2, 2013

I have comments on this.

@westurner
Copy link
Contributor Author

@jreback

can you squash?

I've been in Mercurial land, working with MQ. How do I squash?

@jtratner

I have comments on this.

Shoot.

@cpcloud
Copy link
Member

cpcloud commented Oct 3, 2013

To squash:

# add the remote if you haven't already
git remote add upstream git://github.com/pydata/pandas.git
git fetch upstream
git rebase upstream/master # shouldn't be any merge conflicts
git rebase --interactive upstream/master  # this is where you squash

@westurner
Copy link
Contributor Author

@cpcloud
Thanks.

@jreback
Smushed, I think.

@cpcloud
Copy link
Member

cpcloud commented Oct 3, 2013

When you squash there should be fewer commits than before (you're essentially combining commits). You've now got some commit history from recent master and repeat commits that you'll need to clean up. Here's how:

This will destroy any changes you made in between your previous commits and your squash attempt. You can recover them, but lets only deal with that if we have to.

git reset --hard HEAD~6  # go back to your original before the squash

- Use "raise AssertionError" rather then plain `assert` in library code (using assert is fine
for test code). python -o strips assertions. better safe then sorry.
- When writing tests, don't use "new" assertion methods added to the unittest module
- **ENH**: Enhancement, new functionality
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you move this to the top? I think this is really the key part.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or, rather, right after tests pass.

@jtratner
Copy link
Contributor

jtratner commented Oct 3, 2013

@westurner sorry for holding this up, looks good and thanks. Please make that one change and I'll merge it.

arguments. Add deprecation warnings when needed.
- Performance matters. You can use the included "test_perf.sh"
script to make sure your PR does not introduce any performance regressions
- **Backward-compatibility really** matters. Pandas already has a large user base and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you make this extend through 'matters'

@westurner
Copy link
Contributor Author

@jtratner
Done and done.

@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

Looks like you've still got a bunch of extra history. Can you clear that up? We can merge as soon as you do that. Thanks!

@westurner westurner closed this Oct 4, 2013
@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

@westurner Why did you close?

@westurner
Copy link
Contributor Author

@cpcloud
I guess this was not a good sequence of commands for folding patches:

git reset --soft HEAD~7
git commit -m "..."
git push origin :patch-2

@westurner
Copy link
Contributor Author

... merge conflicts

@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

A soft reset will simply put the commits from HEAD to HEAD~7 (inclusive) in the index, as if you had made all of the changes at once and had just staged them. It won't correct any merge conflicts or other issues

@westurner westurner reopened this Oct 4, 2013
@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

Happy to help u some more with git. I'm very patient.

@westurner
Copy link
Contributor Author

https://travis-ci.org/westurner/pandas/jobs/12120689:

Using worker: worker-linux-3-2.bb.travis-ci.org:travis-linux-6

$ export NOSE_ARGS="not slow"
$ export FULL_DEPS=true
$ export GUI=qt4
$ git clone --depth=50 --branch=patch-2 git://github.com/westurner/pandas.git westurner/pandas
Cloning into 'westurner/pandas'...
fatal: unable to connect to github.com:
github.com: Temporary failure in name resolution

[...]

@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

that's a random failure on travis's end (or maybe github's)

@westurner
Copy link
Contributor Author

Thanks. How do I avoid that extra commit in the PR? I think I reset HEAD~1 one too many times.

@westurner
Copy link
Contributor Author

(Tornado-y weather on the ground here in Omaha at the moment)

@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

Do these commands exactly as I have them here

git reset HEAD~1
git stash
git reset --hard upstream/master
git stash pop
git add .
git commit -m 'WRITE AN AWESOME MESSAGE HERE'
git push --force

@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

but write a differernt commit message

@cpcloud
Copy link
Member

cpcloud commented Oct 4, 2013

bravo! hope that helped and that u understand git a bit more than before :)

@westurner
Copy link
Contributor Author

Thanks so much!

@westurner
Copy link
Contributor Author

@jtratner
Should be good to merge.

jtratner added a commit that referenced this pull request Oct 8, 2013
DOC: CONTRIBUTING.md: Gold plating: syntax, punctuation, Markdown format...
@jtratner jtratner merged commit 239d1be into pandas-dev:master Oct 8, 2013
@jtratner
Copy link
Contributor

jtratner commented Oct 8, 2013

thanks!

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.

4 participants