-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
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
Conversation
... 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. |
can you squash? |
I have comments on this. |
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 |
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@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 |
There was a problem hiding this comment.
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'
@jtratner |
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 Why did you close? |
@cpcloud
|
... merge conflicts |
A soft reset will simply put the commits from |
Happy to help u some more with |
https://travis-ci.org/westurner/pandas/jobs/12120689:
|
that's a random failure on travis's end (or maybe github's) |
Thanks. How do I avoid that extra commit in the PR? I think I |
(Tornado-y weather on the ground here in Omaha at the moment) |
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 |
but write a differernt commit message |
bravo! hope that helped and that u understand git a bit more than before :) |
Thanks so much! |
@jtratner |
DOC: CONTRIBUTING.md: Gold plating: syntax, punctuation, Markdown format...
thanks! |
...ting
✨