Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.09 KB

Contributing

Contributions are welcome! Please read the guidelines below.

Adding a Library

To add a new library, please ensure it:

  • Is actively maintained (recent commits/releases)
  • Has clear documentation
  • Is designed for Node.js
  • Is related to job processing, task scheduling, cron jobs, or background workers

Format

Add libraries using this format:

<tr>
<td width="100%">

### [Library Name](https://github.com/owner/repo)
![Stars](https://img.shields.io/github/stars/owner/repo?style=flat-square)
![Last Commit](https://img.shields.io/github/last-commit/owner/repo?style=flat-square)
![Self-Hostable](https://img.shields.io/badge/Self--Hostable-✅-success?style=flat-square)

Brief description of what the library does and its key features.

</td>
</tr>
  • Use ✅ (green) for self-hostable, ❌ (red) for cloud-only
  • Keep descriptions concise (1-2 sentences)

Pull Request Process

  1. Fork the repo
  2. Add your library to README.md
  3. Ensure all links work
  4. Submit a PR with a clear description

Questions?

Open an issue and we'll help out.

Thanks for contributing! 🚀