Skip to content
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

Changes to README.md #1151

Closed
wants to merge 0 commits into from
Closed

Changes to README.md #1151

wants to merge 0 commits into from

Conversation

LukeTheEngineer
Copy link
Contributor

@LukeTheEngineer LukeTheEngineer commented Mar 28, 2024

No changes to source code

@concussious
Copy link
Contributor

concussious commented Mar 29, 2024

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.

@LukeTheEngineer
Copy link
Contributor Author

Thanks for the knowledge

@bsdimp
Copy link
Member

bsdimp commented Apr 10, 2024

Can you squash all these down into one commit?

README.md Outdated
@@ -15,6 +15,8 @@ See build(7), config(8), [FreeBSD handbook on building userland](https://docs.fr
For information on the CPU architectures and platforms supported by FreeBSD, see the [FreeBSD
website's Platforms page](https://www.freebsd.org/platforms/).

Official FreeBSD bootable images on our [releases page](https://download.freebsd.org/ftp/releases/ISO-IMAGES/) to get yourself one.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think that the other parts of this file use 'our' or similar 1st-person plural pronouns.
For official FreeBSD bootable images, see our [release page](...)
might be better?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it an issue with using "our"?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. It's an informal style that doesn't match the rest of the doc.

@LukeTheEngineer
Copy link
Contributor Author

Can you squash all these down into one commit?

How would I do that?

@concussious
Copy link
Contributor

concussious commented Apr 22, 2024

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.

@bsdimp
Copy link
Member

bsdimp commented Apr 22, 2024

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.

@LukeTheEngineer
Copy link
Contributor Author

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

@bsdimp
Copy link
Member

bsdimp commented Apr 23, 2024

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 bsdimp self-assigned this Apr 24, 2024
@bsdimp bsdimp closed this May 10, 2024
@bsdimp
Copy link
Member

bsdimp commented May 10, 2024

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

freebsd-git pushed a commit that referenced this pull request May 10, 2024
bsdjhb pushed a commit to bsdjhb/cheribsd that referenced this pull request Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants