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

Updated documentation #14

Merged
merged 1 commit into from
Nov 28, 2024
Merged

Conversation

jeawhanlee
Copy link
Collaborator

Description

Fixes #13
Updates documentation

Type of change

  • Enhancement (non-breaking change which improves an existing functionality).

Detailed scenario

N/A

Technical description

Documentation

Updates the readme.md file on detailed steps to setup, configure and use the package.

New dependencies

N/A

Risks

N/A

Mandatory Checklist

Code validation

  • I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
  • I triggered all changed lines of code at least once without new errors/warnings/notices.
  • I implemented built-in tests to cover the new/changed code.

Code style

  • I wrote a self-explanatory code about what it does.
  • I protected entry points against unexpected inputs.
  • I did not introduce unnecessary complexity.
  • Output messages (errors, notices, logs) are explicit enough for users to understand the issue and are actionnable.

Unticked items justification

They don't apply for this PR

Additional Checks

  • In the case of complex code, I wrote comments to explain it.
  • When possible, I prepared ways to observe the implemented system (logs, data, etc.).
  • I added error handling logic when using functions that could throw errors (HTTP/API request, filesystem, etc.)

@jeawhanlee jeawhanlee linked an issue Nov 28, 2024 that may be closed by this pull request
@jeawhanlee jeawhanlee requested a review from a team November 28, 2024 11:33
@jeawhanlee jeawhanlee self-assigned this Nov 28, 2024
@jeawhanlee jeawhanlee added the documentation Improvements or additions to documentation label Nov 28, 2024
@jeawhanlee jeawhanlee merged commit 2d33511 into develop Nov 28, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation
2 participants