Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (16 loc) · 940 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 940 Bytes
Raw

Contributing

Purpose

This plugin is meant to be as possible a 1:1 mapping of the AudioMuse-AI API without adding internal complex logic. To contribute raise PR following the below guidelines.

PR Process

Before you open a PR:

  • Always test your changes locally. Test need to be followed by an human user.
  • Keep changes focused, easy to understand and alligned with the purpose of this plugin.

In the PR:

  • Describe what the PR does in your own words avoiding AI-generated descriptions.
  • AI assistance is allowed when a human reviews and owns the result.
  • Share in the PR all the test that you did so that can be auditable and reproducible.
  • Always keep update the readme.md with API description and example.

Always remember to keep it simple:

  • Avoid complex, niche, or unnecessary features.
  • Prefer clear, maintainable changes over clever or fragile solutions.
  • The plugin should remain easy to use and easy to maintain.