-
Notifications
You must be signed in to change notification settings - Fork 0
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
Docs: Improve README file with more details #40
Open
Sarrabah
wants to merge
4
commits into
main
Choose a base branch
from
docs/update-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sarrabah
changed the title
Docs: Update README file with more details
Docs: Improve README file with more details
Jan 23, 2025
pierrecamilleri
approved these changes
Jan 28, 2025
Comment on lines
+20
to
+23
**User story** | ||
|
||
As a fr-format user, you want to validate a value according to a given French format. This allows you to easily check if the data provided by your project users is valid or not . | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
**User story** | |
As a fr-format user, you want to validate a value according to a given French format. This allows you to easily check if the data provided by your project users is valid or not . |
Me semble redondant avec la phrase d'introduction.
Co-authored-by: Pierre Camilleri <[email protected]>
johanricher
reviewed
Jan 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
This PR updates and improves the README file with more details to better explain the project's objectives, as outlined in issue #33.
Fixes #33