Skip to content

Update developer documentation#199

Merged
magicant merged 2 commits into
trunkfrom
docs
Sep 15, 2025
Merged

Update developer documentation#199
magicant merged 2 commits into
trunkfrom
docs

Conversation

@magicant

Copy link
Copy Markdown
Owner

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

  • Added a new CONTRIBUTING.md file with detailed instructions for contributing to code, documentation, completion scripts, and translations, including guidelines for asking questions, reporting bugs, and proposing new features.
  • Removed the now-redundant TRANSLATING.md file, consolidating translation instructions into the new contributing guide.

Completion Scripts Documentation

  • Added a thorough guide to share/completion/README.md explaining how to write completion scripts for Yash, including file structure, core concepts, utility functions, and examples.

Automated Testing Documentation

  • Expanded tests/README.md to 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]

@magicant
magicant requested a review from Copilot September 15, 2025 08:31
@magicant magicant self-assigned this Sep 15, 2025

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.md file with guidelines for all types of contributions
  • Removed redundant TRANSLATING.md file, 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.

Copilot AI Sep 15, 2025

Copy link

Choose a reason for hiding this comment

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

[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.

Copilot uses AI. Check for mistakes.
@magicant
magicant merged commit 1e0f342 into trunk Sep 15, 2025
5 checks passed
@magicant
magicant deleted the docs branch September 15, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants