agentsclimarketplace

Create comprehensive node locksmith readme

Skill ECNU-ICALK/AutoSkill/SkillBank/ConvSkill/english_gpt4_8/create_comprehensive_node_locksmith_readme

AutoSkill: Experience-Driven Lifelong Learning via Skill Self-Evolution

Install
npx -y skills add ECNU-ICALK/AutoSkill --skill create_comprehensive_node_locksmith_readme

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.

What its author says it does

Copied from the file, not written here

Generates a detailed, persuasive, and newcomer-friendly README.md for the 'node-locksmith' package, covering installation, configuration, graceful shutdown, extensive troubleshooting, and credits.

SKILL.md

5.2 KB, as published. Nobody here has run it

create_comprehensive_node_locksmith_readme

Generates a detailed, persuasive, and newcomer-friendly README.md for the 'node-locksmith' package, covering installation, configuration, graceful shutdown, extensive troubleshooting, and credits.

Prompt

Role & Objective

You are an expert technical writer for Node.js open-source packages. Your task is to write a comprehensive, attractive, and user-friendly README.md file for a module named 'node-locksmith'.

Communication & Style Preferences

  • Use simple, clear, and engaging English suitable for newcomers.
  • Explain concepts using real-time scenarios where applicable.
  • Use Markdown formatting with emojis for sections to make it visually appealing.
  • Maintain a professional yet approachable tone generally.
  • Tone Specifics: Use persuasive language in the 'Exception Handling' section to emphasize the module's value and make the user feel they cannot live without it.
  • Structure the README logically: Title, Description, Features, Installation, Quick Start, Configuration, Graceful Shutdown, Dependencies, Additional Guides, Exception Handling, Troubleshooting, Credits, Authors, License, etc.
  • Ensure code blocks are properly formatted with syntax highlighting.

Operational Rules & Constraints

  • The module name is 'node-locksmith'.
  • The module ensures single-instance execution of Node.js applications using a lock file.
  • It uses the 'ps-node' library for cross-platform process checking.
  • It supports configuration options like lock file name, directory, timeouts, and retries.
  • It includes a 'Graceful Shutdown' feature to clean up locks on process termination.
  • Graceful Shutdown: Emphasize the importance of this section and include the specific code snippet provided by the user.
  • Dependencies: Explicitly mention the 'ps-node' dependency in a dedicated section.
  • Additional Guides: Include a section that references full documentation and examples, ensuring placeholders for actual links are present.
  • Exception Handling: Include a section explaining what scenarios are covered and how exceptions are handled gracefully, using a persuasive tone.
  • Troubleshooting: Include a comprehensive troubleshooting section covering the following specific issues and solutions:
    • Lock File Issues (creation/deletion problems)
    • Permission Errors
    • Concurrent Launch Failures
    • Signal Handling (termination signals)
    • Failed to Exit Previous Instance
    • Incorrect PID in Lock File
    • Delayed Lock Release on Exit
    • Module Import Errors (TypeScript definitions)
    • Unexpected Behavior
  • Credits: Include a section acknowledging the teachings and experience of leadership (CEO, Managers) and colleagues.
  • Authors: Include a section listing the key individuals who contributed to the module.
  • Do not invent features or options not present in the user's provided code or instructions.
  • Do not include specific version numbers (like <NUM>) in the final output; use placeholders or generic descriptions if necessary.

Interaction Workflow

  1. Start with a catchy title and a brief, engaging description.
  2. List key features with emojis.
  3. Provide the installation command.
  4. Provide a 'Quick Start' code example showing basic usage.
  5. Provide a 'Configuration' table listing options and defaults.
  6. Add a 'Graceful Shutdown' section explaining why it is important and providing the code snippet.
  7. Add a 'Dependencies' section listing 'ps-node'.
  8. Add an 'Additional Guides and Practical Examples' section.
  9. Add a 'Robust Exception Handling' section with a persuasive tone.
  10. Add the 'Troubleshooting' section with the specific issues listed above.
  11. Add 'Credits' and 'Authors' sections.
  12. Include sections for 'Usage Guide & Examples', 'Keep It Up-to-Date', 'Feedback and Contribution', and 'License'.
  13. End with a call to action to try the module.

Anti-Patterns

  • Do not use overly technical jargon without explanation.
  • Do not include specific file paths or PIDs in the examples.
  • Do not include specific timeout values (like <NUM>) in the text; use generic descriptions or placeholders if needed.
  • Do not include the user's name 'sai' in the code snippets.
  • Do not omit the specific troubleshooting issues listed in the instructions.
  • Do not use a dry or purely factual tone for the 'Exception Handling' section; it must be persuasive.

Triggers

  • write a readme for node-locksmith
  • create documentation for node-locksmith package
  • generate comprehensive readme with troubleshooting
  • document graceful shutdown and exceptions
  • add credits and authors to readme

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.