Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
146 lines (101 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

146 lines (101 loc) · 4.21 KB

Contributing to Outlook Auto Archive Script

Author: Ryan Zeffiretti

Thank you for your interest in the Outlook Auto Archive Script! This document provides guidelines for contributors, though please note this is an "as-is" script with limited maintenance.

How to Contribute

Reporting Issues

Before creating a new issue, please:

  1. Check if the issue has already been reported
  2. Search existing issues for similar problems
  3. Provide detailed information including:
    • Windows version
    • Outlook version
    • PowerShell version
    • Error messages (if any)
    • Steps to reproduce the issue
    • Expected vs actual behavior

Suggesting Features

When suggesting new features:

  1. Describe the feature clearly
  2. Explain why it would be useful
  3. Provide use cases or examples
  4. Consider if it fits the project's scope

Code Contributions

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test thoroughly
  6. Commit your changes with clear commit messages
  7. Push to your fork
  8. Create a pull request

Development Guidelines

  • PowerShell Best Practices: Follow PowerShell coding standards
  • Error Handling: Include proper error handling and logging
  • Comments: Add comments for complex logic
  • Testing: Test your changes in both dry-run and live modes
  • Backward Compatibility: Ensure changes don't break existing functionality

Code Style

  • Use consistent indentation (4 spaces)
  • Follow PowerShell naming conventions
  • Add comments for complex operations
  • Use descriptive variable names
  • Include error handling where appropriate

Testing

Before submitting a pull request:

  1. Test in dry-run mode first
  2. Test with different Outlook configurations
  3. Verify logging works correctly
  4. Test error scenarios
  5. Ensure no regressions

Pull Request Process

  1. Title: Use a clear, descriptive title
  2. Description: Explain what the PR does and why
  3. Testing: Describe how you tested the changes
  4. Breaking Changes: Note any breaking changes
  5. Documentation: Update README.md if needed

Review Process

  • PRs may be reviewed when time permits
  • Response times may vary due to limited maintenance
  • Once approved, changes will be merged
  • Contributors will be credited in the project

Development Environment

Prerequisites

  • Windows with PowerShell 5.1+
  • Microsoft Outlook
  • Git

Setup

  1. Clone the repository
  2. Ensure Outlook is configured
  3. Test the script in dry-run mode
  4. Make your changes
  5. Test thoroughly

Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help others learn and grow
  • Follow the project's coding standards

Questions?

If you have questions about contributing:

  1. Check the README.md for documentation
  2. Search existing issues for similar questions
  3. Create a new issue with the "question" label

Thank you for your interest in this project! While this is primarily for personal use, community contributions are appreciated.

⚠️ Important Disclaimers

🔒 Data Safety Warning

ALWAYS BACKUP YOUR DATA BEFORE USE! While this script includes safety features like dry-run mode and comprehensive logging, it's your responsibility to ensure you have proper backups of your email data before using this tool.

🛡️ No Warranty

This software is provided "AS IS" without warranty of any kind. The author makes no representations or warranties about the accuracy, reliability, completeness, or suitability of this software for any purpose.

🛡️ Limitation of Liability

The author shall not be liable for any direct, indirect, incidental, special, consequential, or punitive damages, including but not limited to:

  • Loss of data or emails
  • Email corruption or deletion
  • System corruption
  • Any other damages arising from the use of this software

📋 User Responsibility

By using this software, you acknowledge that:

  • You have backed up your email data before use
  • You understand the risks involved in email operations
  • You accept full responsibility for any consequences
  • You will test the software in dry-run mode first
  • You have read and understood all disclaimers