freebsd-src icon indicating copy to clipboard operation
freebsd-src copied to clipboard

Changes to README.md

Open LukeTheEngineer opened this issue 11 months ago • 8 comments

No changes to source code

LukeTheEngineer avatar Mar 28 '24 01:03 LukeTheEngineer

As said in the previous PR, this is an awesome place to put this information.

My first attempt at PR here, I also closed the request and opened a new one. Several times actually. I think this caused clutter, confusion, and extra work for the grandmasters. Eventually I discovered, you can reopen the initial pr (even if the branch is deleted), rename the title, edit the description, anything, by playing with the buttons on the website. One continuous PR seems to make it easier for the comitter to include the history of the review into the tree.

Iirc comments on closed prs didn't send me an email. https://github.com/freebsd/freebsd-src/pull/1140#issuecomment-2024480802

See this instruction to squash your commits into one with a great log message: https://github.com/freebsd/freebsd-src/pull/825#issuecomment-1889670659

I (nobody, mind you, just a hobbyist here) recommend a pr and commit title like, "README.md: Mention image downloads", or "README.md: Link bootable image downloads"... as long as those are <50 characters. I think it was CONTRIBUTING.md that has a great explanation for this.

concussious avatar Mar 29 '24 20:03 concussious

Thanks for the knowledge

LukeTheEngineer avatar Apr 01 '24 15:04 LukeTheEngineer

Can you squash all these down into one commit?

bsdimp avatar Apr 10 '24 03:04 bsdimp

Can you squash all these down into one commit?

How would I do that?

LukeTheEngineer avatar Apr 22 '24 01:04 LukeTheEngineer

Can you squash all these down into one commit?

How would I do that?

As said in the previous PR, this is an awesome place to put this information.

My first attempt at PR here, I also closed the request and opened a new one. Several times actually. I think this caused clutter, confusion, and extra work for the grandmasters. Eventually I discovered, you can reopen the initial pr (even if the branch is deleted), rename the title, edit the description, anything, by playing with the buttons on the website. One continuous PR seems to make it easier for the comitter to include the history of the review into the tree.

Iirc comments on closed prs didn't send me an email. #1140 (comment)

See this instruction to squash your commits into one with a great log message: #825 (comment)

I (nobody, mind you, just a hobbyist here) recommend a pr and commit title like, "README.md: Mention image downloads", or "README.md: Link bootable image downloads"... as long as those are <50 characters. I think it was CONTRIBUTING.md that has a great explanation for this.

Edit: please correct and forgive me if the syntax of this comment is incorrect style in this community.

concussious avatar Apr 22 '24 02:04 concussious

Can you squash all these down into one commit?

How would I do that?

% git rebase -i main $BRANCH_NAME

(where BRANCH_NAME is the name of your branch) then you'll have a number of lines in your editor. They will all be pick <some-hex-number> Description of the commit. Change all the 'pick' to fold (all after the first one). Save the file. This will tell git you want it to combine all the commits.

I don't think README.md has changed since your pull requests. If it had, you'd need to rebase by doing:

% git checkout main
% git pull
% git rebase -i main $BRANCH_NAME

(in this case, just leave what should just be one pick line). Hopefully you'd not have to resolve conflicts.

Once you've done all that, you'll need to push it back to GitHub with % git push --force-with-lease.

bsdimp avatar Apr 22 '24 02:04 bsdimp

I've done git rebase -i main but the commits are no longer there. It displays noop

LukeTheEngineer avatar Apr 23 '24 11:04 LukeTheEngineer

I've done git rebase -i main but the commits are no longer there. It displays noop

Oh! You're not working on a branch. I hadn't noticed that. You'll need to change main to something like origin/main or freebsd/main depending on how you cloned this repo. git remote -v will tell you which one you'll likely want to use. origin/main is the default.

bsdimp avatar Apr 23 '24 21:04 bsdimp

Landed... I think I closed it wrong though.

bsdimp avatar May 10 '24 02:05 bsdimp