šŸ¤ Contributing

We welcome contributions to improve number2words! Whether it's adding a new language, fixing bugs, or improving documentation, your help is appreciated.


šŸš€ How to Contribute

1ļøāƒ£ Fork & Clone the Repository

First, fork the repository on GitHub and clone it to your local machine:

git clone https://github.com/your-username/number2words.git
cd number2words

2ļøāƒ£ Install Dependencies

Ensure you have the Dart SDK installed, then run:

dart pub get

3ļøāƒ£ Add a New Feature or Fix a Bug

  • To add a new language, create a new file under lib/src/languages/ and follow the existing language implementations.

  • If fixing a bug, ensure your changes do not break existing functionality.


4ļøāƒ£ Run Tests

Before submitting changes, run tests to make sure everything works correctly:

dart test

5ļøāƒ£ Submit a Pull Request

  • Push your changes to your forked repo:
git add .
git commit -m "Added support for XYZ language"
git push origin your-branch-name
  • Open a pull request on GitHub, describing your changes.

šŸ“Œ Contribution Guidelines

āœ”ļø Follow the existing code style.
āœ”ļø Ensure all new features include proper documentation.
āœ”ļø Write tests for any new functionality.
āœ”ļø Keep pull requests focused and concise.


🌟 Get in Touch

For discussions, issues, or feature requests, open an issue on GitHub or reach out to us.

šŸ”— Next: Check out the License section for usage details. šŸš€

Updated on