1.0.0 • Published 1 year ago

@dunkelhaiser/numeri-romani v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Numeri Romani

JavaScript library for work with Roman numbers.

Features

  • TypeScript and JSDoc support
  • Conversion between Roman and Arabic numbers
  • Ability to perform basic mathematical operations

Installation

npm install @dunkelhaiser/numeri-romani
yarn add @dunkelhaiser/numeri-romani
pnpm add @dunkelhaiser/numeri-romani
bun add @dunkelhaiser/numeri-romani

Contributing

Bug Reporting

If you come across a bug or unexpected behavior, please take the time to report it. To file a bug report:

  1. Check if the issue has already been reported by searching the issues.
  2. If the issue hasn't been reported yet, open a new issue, providing as much detail as possible, including:
  • A clear and concise title.
  • A detailed description of the issue.
  • Steps to reproduce the problem.
  • Expected and actual behavior.

Feature Proposals

To propose a new feature:

  1. Check the issues to ensure it hasn't been proposed before.
  2. Open a new issue, clearly describing the new feature or enhancement you would like to see.
  3. Provide any relevant details or use cases that will help understand the use of the proposed feature.

Code Contributions

To contribute code:

  1. Fork the repository.
  2. Create a new branch for your changes with a specific prefix: git checkout -b feat/your-feature. Accepted prefixes: feat, fix, refactor, docs.
  3. Make your changes, following the coding style.
  4. Write unit tests for your changes.
  5. Update the README or documentation if necessary.
  6. Submit a pull request to the dev branch of the original repository.
  7. Provide a detailed description in the pull request, explaining the purpose of your changes.

License

Copyright (c) 2024 Kyrylo Tymchyshyn
Licensed under the MIT license.

ko-fi