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. š