• How to Help?

• Contribution Guidelines

• Getting Started

• Testing

  • Unit tests
  • REPL
  • Test build

• Code Style Guide

  • Lint the Code

• Documentation

  • JSDoc

Help is always welcome. There are areas where you can help:

• The core functionality (performance improvements, bug fixes, new features, etc.).

• Documentation (markdown documents, JSDoc annotations in source code).

• Test suite & development environment improvements.

If you see a gap, but don't have time, experience, or you just need help with the library, don't hesitate to start a discussion or open a new issue.

External dependency binaries are shipped as sidecar. And this needed to be download in run time. If you want to contribute to functionality then please leave a comment to the fluent downloader issue if your interested.

Due to the alpha state of the project I am more than open to make it stable.

Please follow the main contributing rules, to maintain fluent-downloader's top quality:

• Follow style guides:

  • Lint the code.

• Write tests.

• Write documentation.

• Don't update the changelog.

• Don't change the library version.

1. Install latest Nodejs (LTS recommended)

2. Install or upgrade to the latest pnpm.

3. Fork the project, and clone your fork of the repo

4. Run pnpm install to install the dev dependencies

Testing is not yet implemented. But will be implemented soon.

The project follows Prettier code style and will use ESLint as the linter.

• TSDoc will be used for the code documentation.