49 lines (34 loc) · 1.32 KB

Contributing to numberstring

First off, thanks for taking the time to contribute!

How Can I Contribute?

Reporting Bugs

Check if the bug has already been reported in Issues
If not, open a new issue with a clear title and description
Include code samples and expected vs actual behavior

Suggesting Features

Open an issue describing the feature
Explain why it would be useful

Adding a New Language

We'd love help adding more languages! Here's how:

Create a new file in languages/ (e.g., pt.js for Portuguese)
Follow the pattern in languages/en.js
Export a default function that converts numbers to words
Add your language to languages/index.js
Add tests in test/index.test.js
Update README.md with the new language
Submit a PR!

Pull Request Process

Fork the repo and create your branch from main
Run npm install to install dependencies
Make your changes
Run npm test to ensure tests pass
Run npm run lint to check code style
Update documentation if needed
Submit your PR!

Code Style

ES2022+ syntax (const/let, arrow functions, async/await)
ESM modules only
Add JSDoc comments for public functions
Maintain test coverage

Code of Conduct

Be respectful and inclusive. We welcome contributors of all backgrounds and experience levels.