πŸ›  Contributing to Deletor

April 27, 2025 Β· View on GitHub

Thank you for considering contributing to Deletor!
Here’s how you can help improve this project.


πŸš€ First-Time Contributors

If you’re new to open source, check out these good first issues:
(Look for the good first issue label in Issues).


πŸ§‘β€πŸ’» How to Contribute

1. Report a Bug

  • Check if the bug is already reported in Issues.
  • Provide details:
    - OS version  
    - Steps to reproduce  
    - Expected vs actual behavior  
    - Logs if possible
    

2. Suggest a Feature

  • Open an Issue with the enhancement label.
  • Describe the use case and proposed solution.

3. Submit Code

  1. Fork the repository.
  2. Branch from main:
    git checkout -b fix/2-parallel-processing
    
  3. Commit changes:
    git commit -m "feat: #2 parallel file processing"
    
  4. Push and open a Pull Request with:
    • Screenshots/logs if applicable.

πŸ”§ Development Setup

Prerequisites

  • Go 1.20+

Steps

  1. Clone the repository
  2. Install dependencies
  3. Run tests or build

Steps

Clone the repo

git clone https://github.com/pashkov256/deletor.git  

πŸ“œ Code Guidelines

  • Formatting: Use gofmt.
  • Comments: Document public functions with GoDoc.

❓ Need Help?

Feel free to reach out on Telegram

πŸ™Œ Thank you for contributing!