pure-data / pddp

Pure Data Documentation Project
7 stars 2 forks source link

stop creating PRs for every commit? #181

Closed umlaeute closed 6 months ago

umlaeute commented 7 months ago

don't know where to put this, but... now that we have #175 in place, I see that the history of the documentation branch becomes like this:

documentation-branch

i figure, you don't ever look at the commit history, but I do regularly and it is a real eye sore.

so: can we avoid this?

when setting up the branch rules for the documentation branch I was tempted to add Force a linear history to the rules, but i thought that that would create more problems when a couple of people work together (and it seems overly pedantic anyhow). rethinking, it's probably not a bad idea anyhow, since any trivial merge can be easily turned into a rebase, and any non-trivial merge won't work for Pd-patches anyhow.


for reference: here's how I would have imagined the history to look like documentation-branch2

umlaeute commented 7 months ago

i just noted that i got very derailed from the subject. there are actually two different issues:

the title speaks of the 2nd, but my description deals with the first.

i'm really concerned with both.

as i've explained the spiderweb already, here's my hitch on the PRs:

when you create a PR all people subscribed to the repository will get notified. when the PR is closed, they will also get notified (I think luckily github will not create two notifications for the "open" and "close" events if they are chronologically close). this makes my GitHub inbox full with useless stuff (as @porres can do all the things by themselves). an inbox full of useless stuff buries important messages, which i would like to prevent.

github allows me to unsubscribe from the notifications of a repository, but i do not want to do this for the pure-data repo: I do care about it, and I want to be notified of things in this repository that are actually important.

i do not think that i can configure github to not send me any notifications from a single person (and i'm not sure whether i would want all messages from @porres to be blocked; i'm just annoyed by those useless PRs). i'm pretty sure that i cannot configure github to not send me "useless notifications".

umlaeute commented 7 months ago

with no dissents, i've now applied the rule to force "linear history", for solving the "spiderweb history".

please let me know if this creates any problems.

the "useless PRs" are not tackled at all.

porres commented 7 months ago

@porres could just directly push to the documentation branch in the pure-data repository (and completely drop the porres/Documentation branch).

sure, I'l ltry next time

if you insist on merging via the webinterface, you could

accumulate more commits before merging always use Rebase and merge for merging to keep the history linear

I am quite used to using 'github desktop' and the web interface, I can also try to "Rebase and merge"

with no dissents, i've now applied the rule to force "linear history", for solving the "spiderweb history".

please let me know if this creates any problems.

the "useless PRs" are not tackled at all.

hmmm, so, I just keep doing what I was doing then? :)

umlaeute commented 7 months ago

hmmm, so, I just keep doing what I was doing then? :)

you shouldn't have to care about the "Rebase and Merge" anymore, as (I think) the only option fr you to merge is now exactly that.

but since this issue is really about "stop creating PRs for every commit", you still should push directly to the documentation branch, and not create an extra PR (for merging your changes into the documentation branch) at all. (we will need to create a new Documentation fixes PR once documentation got merged, just like with the stable development branch; but that is a single PR until miller merges it)

porres commented 6 months ago

I just tried another commit and it seems I did it again, right?

I had the impression things would just magically work now

umlaeute commented 6 months ago

Depends on what you mean by "it" (and I'm currently afk so I don't want to do a full analysis of the situation).

Anyhow, you can push whatever you like to your own branches and nobody cares how you call these branches. It is only important that whatever you want to go into the documentation branch of the pure-data repository is pushed to the documentation branch of the pure-data repository (and you can and should push directly without doing any PRs)

porres commented 6 months ago

Depends on what you mean by "it"

I think I created a new PRs for a new commit (and also every future one if I keep doing the same), didn't I?

porres commented 6 months ago

didn't I?

Just did another pull but paying attention now, seems I'm, looks like I'm doing more PRs for sure...

It is only important that whatever you want to go into the documentation branch of the pure-data repository is pushed to the documentation branch of the pure-data repository (and you can and should push directly without doing any PRs)

I do have a local 'documentation' branch in my fork and I do target the documentation branch of the pure-data repository...

Screen Shot 2024-01-05 at 12 58 34

and it only shows me an option to create a pull request

(and you can and should push directly without doing any PRs)

i wouldn't know how, I am of course using the github desktop app and the web resources, maybe you mean I can do it via some command line in the terminal. After I click the PR button I go to the web and it only shows me how to create a PR

Then I can "squash and merge"

Screen Shot 20
![Screen Shot 2024-01-05 at 12 59 49](https://github.com/pure-data/pddp/assets/5360142/f0fee3d5-2b64-4c1d-ba23-e561cc6f6ad2)
24-01-05 at 12 59 30

If this is not good, let me know please

Lucarda commented 6 months ago

someone must correct me if i got it wrong but basically you have to:

porres commented 6 months ago

ok, now that I am part of pure-data, I was able to clone directly from pd repo and not my fork

I did a small test change in https://github.com/pure-data/pure-data/pull/2147/commits/570be229473828253961a77db5b57c5d560cc7c9 and pushed it, no PR, couldn't be easier, thanks!

porres commented 6 months ago

I'm just doing what I usually do in the github app like I do with ELSE, no brainer... sorry for not figuring out sooner and thanks again