Enhance documentation for xAPI project #407
Merged
Conversation
This file contains hidden or 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
Updated documentation to clarify sample applications and added instructions for running builds after changes.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the xAPI project documentation by clarifying sample application descriptions and adding workflow guidance for developers. The changes improve the developer experience by making build processes more explicit and providing better context about test patterns and samples.
- Added "After Making Changes" section to reinforce running builds after code changes
- Enhanced description of samples module to mention the included LRS implementation
- Added test pattern guideline (Given When Then pattern)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
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.
Updated documentation to clarify sample applications and added instructions for running builds after changes.
Description
Resolves # (issue)
Checklist: