Skip to content

Latest commit

 

History

History
96 lines (86 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

96 lines (86 loc) · 3.17 KB

💪 Interested in contributing?

Nice! Please read the few sections below to understand how to implement new features.

👨‍💻 Extending metrics

Be sure to read [/ARCHITECTURE.md] first to understand how metrics is structured and to follow 🔧 Local setup for development to get a working development environment!

Before working on something, ensure that it will not duplicate any active open pull requests (including drafts).

It is advised to open a 💬 discussion first to gather feedback about new features.

⚠️ To avoid an ever-growing backlog, inactive pull requests will be closed after 3 weeks and locked after 5 weeks.

😅 Be positive! Even if your changes don't get merged in lowlighter/metrics, please don't be too sad, you will always be able to run workflows directly from your fork!

🤝 Accepted contributions

The following contributions are accepted:

Section Editions Additions Notes
🧩 Plugins ✔️ ✔️
  • New features for existing plugins are allowed but must be optional and backward compatible
  • New community plugins are welcomed provided they're functional and not redundant with existing plugins
🖼️ Templates
  • Templates editions are allowed with new features additions (but must remain consistent with current visuals)
  • New templates should use 📕 Community templates instead
🪛 Presets ✔️ ✔️
  • New presets are welcomed provided they're functional and not redundant with existing presets
  • Note that presets are on @presets branch
🧪 Tests ✔️ ✔️
  • Everything that make metrics more stable is welcomed!
🧱 Core
  • Core editions impacts all rendering process and should be avoided unless necessary
  • New dependencies should be avoided when possible
🗃️ Repository
  • Workflows, license, readmes, etc. usually don't need to be edited

Legend

  • ✔️: Contributions welcomed!
  • ✓: Contributions welcomed, but must be discussed first
  • ❌: Only maintainers can manage these files