[16.0][IMP] sale_order_line_menu : improve Readme

[TumbaoJu]

Improve Description and Usage
Add Context

[TumbaoJu]

@OCA/oca-consultants : Here is the example used for the Guidelines.

[TumbaoJu]

@sbidoul : I seem to have a problem with the images. I did the drag & drop into the static/description folder in my forked repository and did the commit and PR. But is does not work. Any ideas?

[rousseldenis]

@sbidoul : I seem to have a problem with the images. I did the drag & drop into the static/description folder in my forked repository and did the commit and PR. But is does not work. Any ideas?

@TumbaoJu It seems ok:

[rousseldenis]

LGTM.

Can you squash your commits ?

[vdewulf]

Hi @rousseldenis

Thanks for your help, as usual!

Thanks to your request, I'll finally discover what it this "squash your commits" phase. I read about it here:
https://github.com/OCA/maintainer-tools/wiki/Merge-commits-in-pull-requests
It explains how to do it with terminal interface (I suppose).

I am not sure @TumbaoJu is using a terminal. Is there a way to squash commits using the Graphical interface on Github?
I found this Github official doc:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges

I couldn't spend too much time here, so I'll let Julie follow up and indicate if she found the way to "squash her commits".
Curious to see the next steps!

[rousseldenis]

Hi @rousseldenis

Thanks for your help, as usual!

Thanks to your request, I'll finally discover what it this "squash your commits" phase. I read about it here: https://github.com/OCA/maintainer-tools/wiki/Merge-commits-in-pull-requests It explains how to do it with terminal interface (I suppose).

I am not sure @TumbaoJu is using a terminal. Is there a way to squash commits using the Graphical interface on Github? I found this Github official doc: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges

I couldn't spend too much time here, so I'll let Julie follow up and indicate if she found the way to "squash her commits". Curious to see the next steps!

Indeed, this is not available through Github web interface.

But, I've discovered Github desktop for Windows/Mac that offers that command in a graphical interface : https://github.com/apps/desktop

@TumbaoJu Maybe you can give a try following these instructions ?

https://docs.github.com/en/desktop/managing-commits/squashing-commits-in-github-desktop

[pedrobaeza]

I think that using VSCode integration in GitHub may help for amending commits. Just type . when browsing code to enter VSCode.

[rousseldenis]

I think that using VSCode integration in GitHub may help for amending commits. Just type . when browsing code to enter VSCode.

I think that using VSCode integration in GitHub may help for amending commits. Just type . when browsing code to enter VSCode.

Ooooh yes, I forgot that.

[TumbaoJu]

@rousseldenis @pedrobaeza : Thank you both for your comments.
I did this contribution as an example to be able to explain how to contribute to modules documentation if you are a non-technical person.

In the instructions, we are using the web editor (VS Code) to commit, but I did'nt know how to create the PR and or squash the commits using the VS Code interface.

I will look into the documentation @vdewulf proposed and try to do it.

[TumbaoJu]

@rousseldenis @pedrobaeza : I have looked into it and don't know how to squash the commits even with the VS Code interface.
I would need help!

[pedrobaeza]

Right now is not possible. What I said is that when committing more changes, instead of creating a new commit, is to mark to amend previous commit, so everything sticks together since the beginning.

[gurneyalex]

Could we not use the squash and merge feature for this? Maybe we could have the ocabot perform this through a dedicated command ("ocabot squash merge patch" for instance) ?

[TumbaoJu]

Could we not use the squash and merge feature for this? Maybe we could have the ocabot perform this through a dedicated command ("ocabot squash merge patch" for instance) ?

I like this proposition. The idea is attract non-technical persons to contribute to module documentation so if we can ease the process for Read Me updates it could be great.

@sbidoul : FYI

[florenciafrigieri2]

Changes in readme ok

[OCA-git-bot]

This PR has the approved label and has been created more than 5 days ago. It should therefore be ready to merge by a maintainer (or a PSC member if the concerned addon has no declared maintainer). 🤖