Skip to content

Correct the patch-submission docs #22

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

Merged
merged 1 commit into from
Jun 6, 2025
Merged

Correct the patch-submission docs #22

merged 1 commit into from
Jun 6, 2025

Conversation

sjg20
Copy link
Collaborator

@sjg20 sjg20 commented Jun 2, 2025

We are using pull-requests now, not patches, so update the docs to be consistent with that.

Copy link

netlify bot commented Jun 2, 2025

Deploy Preview for fluffy-chebakia-3fa329 ready!

Name Link
🔨 Latest commit 5a32c04
🔍 Latest deploy log https://app.netlify.com/projects/fluffy-chebakia-3fa329/deploys/6842d22f1caff700087da789
😎 Deploy Preview https://deploy-preview-22--fluffy-chebakia-3fa329.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@QSchulz QSchulz left a comment

Choose a reason for hiding this comment

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

Some changes suggested but no blocker. Thanks for doing that!

README.md Outdated
* Patches should be submitted via a pull-request at
https://github.com/open-source-firmware/flat-image-tree/pulls
* Sign up to the mailing list at https://lists.osfw.foundation/g/flat-image-tree
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (non-blocking): reorder

It's a bit odd to say to use the mailing list for things A, but patches another way, but hey this is how to sign up to the mailing list.

I would suggest to reorder the list such that

Patches should be submitted via a pull-request at https://github.com/open-source-firmware/flat-image-tree/pulls

be either first or last in the list.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done, I think, but please check that I understood you correctly.

Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM

README.md Outdated
Comment on lines 12 to 13
* Patches should be submitted via a pull-request at
https://github.com/open-source-firmware/flat-image-tree/pulls
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (non-blocking): deduplicate info

The Contributions section already explains how it's done (plus some more info), so maybe avoid to repeat it here so we don't get contradicting info.

You could instead use a link something like

For patches, please read the [Contributions section](#contributions)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM

We are using pull-requests now, not patches, so update the docs to be
consistent with that.

Signed-off-by: Simon Glass <[email protected]>
Reported-by: Quentin Schulz <[email protected]>
Fixes: #19
@QSchulz
Copy link
Contributor

QSchulz commented Jun 6, 2025

LGTM

@sjg20
Copy link
Collaborator Author

sjg20 commented Jun 6, 2025

Thanks for helping with this!

@sjg20 sjg20 self-assigned this Jun 6, 2025
@sjg20 sjg20 requested review from xypron and walterchris June 6, 2025 13:11
@walterchris walterchris merged commit decd707 into main Jun 6, 2025
5 checks passed
@walterchris walterchris deleted the docs branch June 6, 2025 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants