Comments (13)
Committing breaking or WIP code makes lots of sense. I do it all the time. Squash-and-merge allows this kind of workflow during a PR without having it bleed into the final history.
from streamz.
Perhaps we should have a suggestion message on the commits, with rebase instructions, such as:
To squash your commits, please type:
git rebase -i HEAD~N
where N is the number of commits you want to squash. You will be shown a list of commits. Please replace pick
with squash with each commit except the latest. When finished, you will be prompted for a commit message. Please write as detailed (but terse) of a commit as you can. Remember to keep the first line short, and add the longer details two lines below.
When finished, you will have to force push to your branch:
git push origin mybranch -f
where origin
is the alias to your remove and mybranch
is your branch.
Also, tried to conform with discussion here in #66
from streamz.
from streamz.
squash-and-merge works for me. I personally am often guilty of committing breaking code usually as a way to keep track of where I'm at in the middle of a refactor or so I can have other people look at the code, so I'm usually less strict about it, but I could try to be cleaner about that. I guess with squash-and-merge we are guaranteed that all tests pass so long as travis passes on the last commit so I am ok with that.
from streamz.
Do we want a .github/contributing.md
to go along with this? (Can we just lift one off of another pydata project?)
Edit: formatting
from streamz.
from streamz.
That's fair (maybe github should have an advanced contributing guide). Do you want to enshrine this information somewhere? If so, where?
from streamz.
from streamz.
I am fine with whichever. Personally, I do like micro commits as they could be useful for code forensics. But the PR's can also serve this (assuming that we can still see comments on outdated diffs after the history has been modified?).
from streamz.
thanks, I was not aware of this!
from streamz.
@jrmlhermitte - that level of git experience is so far above most analysts that you'd be excluding a lot of people and introducing a huge barrier to contribution. As @mrocklin says the GitHub UI can do that for you and that can even be enforced by the repo settings.
from streamz.
I think this issue was really aimed at all those who have merging privileges, since we can do the squash via github and its our responsibility to make sure that the history is as we expect it.
from streamz.
so we've been squashing and merging. Should we write up some developer documentation to close this?
from streamz.
Related Issues (20)
- missing positional argument: 'topic' in to_mqtt HOT 5
- How to parametrize stream/pipeline creation? HOT 2
- Passing Username and Password to from_mqtt() HOT 4
- Dynamically add upstreams to zip HOT 2
- Dropping `pkg_resources`
- AttributeError: 'Output' object has no attribute '_ipython_display_' HOT 3
- flatten doesn't work with iterables without defined length HOT 2
- visualizing streams and changing variables during runtime HOT 5
- Is it possible to use event time/syntethic time rather than system time? HOT 2
- Time based lookback window? HOT 1
- Streamz not working in Jupyterlite
- Collect does not allow awaitable sinks
- Quickstart lacks conda/environments/streamz_dev.yml HOT 6
- Hello from LorryStream and Kotori / Streamz is cool HOT 1
- Add pytest fixture to clean up the IO loop HOT 4
- Streamz hvplot resets zoom and pan on each update HOT 3
- streamz's typing system can't work properly in vscode HOT 2
- Streamz with websocket not steaming any data HOT 5
- Parallel streams with buffers HOT 3
- Is streamz not maintained anymore? What happened to cuStreamz? HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from streamz.