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.

Sign up for GitHub

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

Jump to bottom

Update CONTEXT.md #608

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Update CONTEXT.md #608

merged 1 commit into from
Jun 25, 2024

Conversation

florenciafrigieri2
Copy link
Contributor

We add more information about the context section

@florenciafrigieri2
Update CONTEXT.md
24c1309 
We add more information about the context section
@florenciafrigieri2
Copy link
Contributor Author

@sbidoul Hi Stephane! Can you please check this change?

cc @TumbaoJu @manuelfcordoba

sbidoul
sbidoul reviewed Mar 19, 2024
View reviewed changes
template/module/readme/CONTEXT.md
It should explain the “why” of the module:

- in which context or use cases this module can be useful (practical examples are welcome!).
BUSINESS NEED:
Copy link
Member

Choose a reason for hiding this comment

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

I worry a little bit that people will misinterpret these capitalized words as subtitles they have to copy in their actual documentation, which would be a little bit strange.

Copy link
Contributor

Choose a reason for hiding this comment

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

Those sections are examples of how to structure the Context Fragment, not mandatory content.
I find id really helpful because sometimes you just don't know where to begin.

@TumbaoJu
Copy link
Contributor

@sbidoul Can you merge this PR?

@OCA-git-bot
Copy link

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). 🤖

2 similar comments
@OCA-git-bot
Copy link

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). 🤖

@OCA-git-bot
Copy link

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). 🤖

@sbidoul sbidoul merged commit d3e09ae into OCA:master Jun 25, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TumbaoJu TumbaoJu TumbaoJu approved these changes

@sbidoul sbidoul sbidoul approved these changes

Assignees
No one assigned
Labels
approved ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@florenciafrigieri2 @TumbaoJu @OCA-git-bot @sbidoul