Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request improves developer documentation by consolidating and expanding guidance for contributors and users. The changes focus on creating a comprehensive contributing guide, adding thorough documentation for completion scripts, and enhancing test writing instructions.
- Added a new comprehensive
CONTRIBUTING.mdfile with guidelines for all types of contributions - Removed redundant
TRANSLATING.mdfile, consolidating translation instructions into the contributing guide - Enhanced documentation for writing completion scripts and test cases
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
CONTRIBUTING.md |
New comprehensive guide covering code contributions, documentation, completion scripts, and translations |
tests/README.md |
Added detailed section on writing test cases with examples and harness documentation |
share/completion/README.md |
New thorough guide explaining how to write completion scripts for Yash |
TRANSLATING.md |
File removed as content was consolidated into CONTRIBUTING.md |
Comments suppressed due to low confidence (1)
tests/README.md:7
- Grammar error: 'does not' should be 'do not' to agree with the plural subject 'test cases'.
shell is supposed to pass the POSIX tests, so those test cases does not
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| You can have any custom logic to generate the list of words to complete. | ||
|
|
||
| It is important to pass the `-P "$PREFIX"` option to `complete`. This ensures that completion candidates are generated based on the non-prefix part of the word being completed. |
There was a problem hiding this comment.
[nitpick] The documentation mentions passing -P \"$PREFIX\" but doesn't show this in any of the examples above. Consider adding an example demonstrating this usage for clarity.
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
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.
This pull request introduces new and expanded documentation to help contributors and users understand how to work with the Yash shell project. The most important changes are the addition of a comprehensive contributing guide, improved documentation for writing completion scripts, and expanded instructions for writing and running automated tests.
General Documentation Improvements
CONTRIBUTING.mdfile with detailed instructions for contributing to code, documentation, completion scripts, and translations, including guidelines for asking questions, reporting bugs, and proposing new features.TRANSLATING.mdfile, consolidating translation instructions into the new contributing guide.Completion Scripts Documentation
share/completion/README.mdexplaining how to write completion scripts for Yash, including file structure, core concepts, utility functions, and examples.Automated Testing Documentation
tests/README.mdto include an introduction and detailed instructions on writing test cases using the provided test harness, with examples and explanation of available options and aliases. [1] [2]