Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.37 KB

File metadata and controls

34 lines (23 loc) · 1.37 KB

Contributing to YOURLS

Issue tracker

Use the issue tracker for bug reports, feature requests, and pull requests. Personal support must be discussed using discussions space.

Bug reports

Search existing issues (open and closed) before reporting. Ensure the alleged behavior is observed on the latest version. A good report includes YOURLS/MySQL/PHP versions, expected and actual behavior, and steps to reproduce the problem.

Feature requests

YOURLS aims to stay lean and cover the needs of the vast majority of users. If a feature wouldn't be useful to nearly everyone, it probably belongs in a plugin rather than core. The plugin architecture is designed to extend core behavior for the custom use cases.

Make sure your idea fits the project's scope, and provide context to make a strong case.

Pull requests

  • It's better to ask before starting any significant work.
  • AI use must follow our AI Policy.
  • Keep pull requests focused.
  • Limit pull requests to a single concern.
  • Avoid unrelated changes such as whitespace fixes or rewording comments elsewhere in the codebase.
  • Follow existing coding conventions.
  • Unit tests are very welcome.
  • Your code will be licensed under the MIT License.

❤️ Thank you!