Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.75 KB

Contributing to macOS Developer Setup

Thank you for your interest in contributing to this project! This document provides guidelines for contributing to the macOS Developer Setup repository.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please:

  1. Check if the issue already exists
  2. Create a new issue with a clear title and description
  3. Include your macOS version and system information
  4. Provide steps to reproduce the issue (if applicable)

Suggesting Applications

To suggest new applications for inclusion:

  1. Open an issue with the "enhancement" label
  2. Include:
    • Application name
    • Category (Development, Professional, Communication, Utilities)
    • Installation method (Homebrew Cask, direct download, etc.)
    • Brief description of why it should be included

Submitting Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Test your changes on a fresh macOS installation
  5. Commit your changes: git commit -m 'Add amazing feature'
  6. Push to the branch: git push origin feature/amazing-feature
  7. Open a Pull Request

Code Style

  • Use consistent indentation (4 spaces for shell scripts)
  • Add comments for complex logic
  • Follow the existing naming conventions
  • Test all changes before submitting

Testing

Before submitting changes:

  1. Test on a fresh macOS installation (if possible)
  2. Verify all applications install correctly
  3. Check that the interactive menu works properly
  4. Ensure error handling works as expected

Development Setup

  1. Clone the repository
  2. Make your changes
  3. Test locally
  4. Submit a pull request

Questions?

Feel free to open an issue for any questions about contributing!