UNPKG

s3-file-manager

Version:

A streamlined, high-level S3 client for Node.js with built-in retries and support for uploads, downloads, and file operations — works with any S3-compatible storage.

33 lines (22 loc) 1.49 kB
# Contributing to s3-file-manager Thank you for your interest in improving **s3-file-manager**! Contributions are welcome. ## How to Contribute 1. **Open an Issue**: If you have found a bug, want to suggest an enhancement, or plan to add support/improvements for a specific language, please open an issue first. Describe your proposed change or the problem clearly. 2. **Fork and Branch**: - Fork the repository. - Create a new branch with a descriptive name for your change (e.g., `fix-download-file`). 3. **Write Tests**: - Where applicable, include or update tests to cover your changes. 4. **Submit a Pull Request**: - Push your branch to your fork. - Submit a pull request (PR) describing what you’ve done and referencing the issue you opened (if applicable). ## Development Guidelines - Ensure code is formatted consistently. - Use clear commit messages. - Document any new functionality or changes in behavior in the README as needed. ## Community Standards - Be respectful in discussions and reviews. - Recognize that language-specific contributions are particularly valuable here — native speakers and experts are especially encouraged to help improve transliteration quality. - Improvements to transliteration accuracy, especially for specific languages, will need to come from community contributions. As the project owner, I do not have the expertise to address those issues alone. Thank you for helping make **s3-file-manager** better!