Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.66 KB
Raw

Contributing

Thank you for helping improve Awesome Stack-chan.

This list is intended to collect useful public resources for Stack-chan / ｽﾀｯｸﾁｬﾝ. Japanese and English resources are both welcome.

Repository topics

Maintainers can set GitHub Topics awesome and awesome-list for discovery.

What can be added

Suitable entries include:

  • Stack-chan hardware mods.
  • Firmware, software, and tools.
  • AI, LLM, and voice conversation integrations.
  • 3D printable parts and accessories.
  • Build logs, tutorials, and technical articles.
  • Videos and demos.
  • Community resources.

Pull request guidelines

Please follow these guidelines when opening a pull request:

  • Add one entry per pull request in principle.
  • Search existing entries first and avoid duplicates.
  • Add the entry to the most appropriate category.
  • Use only publicly accessible links.
  • Keep the description short, neutral, and ending with a period.
  • Use this entry format: - [Name](URL) - Short neutral description.
  • If you are adding your own project, mention that you are the author in the pull request description.

Links to avoid

An entry may be declined or postponed if it is:

  • Unrelated to Stack-chan.
  • Inaccessible or requires login.
  • Duplicated or already covered by an existing entry.
  • Abandoned in a way that makes the resource unclear or unusable.
  • Unclear in purpose or relationship to Stack-chan.
  • Spammy or purely promotional, including links that are mostly advertising.

Review approach

The list aims to be useful and welcoming rather than overly strict at the beginning. Maintainers may ask for small edits to category placement, link quality, or description wording.