dsmt 0.1.0 → 0.1.1

package/CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Contributing to Docker Storage Migration Tool (DSMT)
+
+Thank you for considering contributing to DSMT! This document provides guidelines and instructions to help you contribute effectively.
+
+## Code of Conduct
+
+This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before submitting a bug report:
+
+- Check the [issue tracker](https://github.com/itskdhere/dsmt/issues) to see if the issue has already been reported
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/itskdhere/dsmt/issues/new?template=bug_report.md)
+
+When filing a bug report, please include:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- System information (OS, Docker version, Node.js version)
+- Any relevant logs or error messages
+
+### Suggesting Features
+
+We welcome feature suggestions! [Open an issue](https://github.com/itskdhere/dsmt/issues/new?template=feature_request.md) with your idea, providing as much context and detail as possible.
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a new branch for your feature or bugfix
+3. Make your changes
+4. Ensure your code follows the project style and passes all tests
+5. Submit a pull request
+
+## Development Setup
+
+```bash
+# Clone your fork of the repo
+git clone https://github.com/YOUR-USERNAME/dsmt.git
+cd dsmt
+
+# Install dependencies
+npm install
+
+# Start development mode (watches for changes)
+npm run dev
+
+# Link the package globally for testing
+npm link
+```
+
+## Project Structure
+
+- cli.ts - CLI entry point
+- cmd - Command implementations
+- docker - Docker API wrapper
+- types - TypeScript type definitions
+
+## Coding Guidelines
+
+- Use TypeScript for all new code
+- Follow existing code style (2 spaces for indentation)
+- Add appropriate error handling and logging
+- Document new functions and methods
+
+## Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters
+- Reference issues and pull requests liberally after the first line
+
+## Testing Your Changes
+
+Please ensure your changes work properly with:
+
+- Different types of Docker volumes
+- Bind mounts with various path structures
+- Different operating systems (if possible)
+
+## Submitting Changes
+
+1. Push your changes to your fork
+2. Submit a pull request to the main repository
+3. The title of your PR should clearly describe the change
+4. Link any relevant issues in the PR description
+
+## License
+
+By contributing to DSMT, you agree that your contributions will be licensed under the project's MIT License.
+
+## Questions?
+
+Feel free to open an issue if you have any questions about contributing.
+
+Thank you for contributing to DSMT!

package/README.md

@@ -1,4 +1,4 @@
-# 🐳 Docker Storage Migration Tool (DSMT) 📦
+# 🐳 Docker Storage Migration Tool 📦
 
 A command-line utility for seamlessly exporting and importing Docker volumes and bind mounts.
 
@@ -72,19 +72,13 @@ dsmt export /var/www/html /backups
 dsmt import ./html.tar.gz /var/www/html
 ```
 
-## 🛠️ Development
+## 🛠️ Contribution
 
-```bash
-# Clone the repository
-git clone https://github.com/itskdhere/dsmt.git
-cd dsmt
+Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on contributing to this project.
 
-# Install dependencies
-npm install
+## 🔒 Security
 
-# Run the development build
-npm run dev
-```
+Please refer to the [SECURITY.md](SECURITY.md) file for security-related issues and reporting.
 
 ## 📄 License
 

package/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| > 0.1.0 | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+:octocat: https://github.com/itskdhere/dsmt/security/advisories/new  
+📧 [support@itskdhere.eu.org](mailto:support@itskdhere.eu.org)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsmt",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Docker Storage Migration Tool",
   "type": "module",
   "bin": {

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-kd@itskdhere.eu.org.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.