Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (20 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.36 KB
Raw

Contributing to SpaceGuard

Thank you for your interest in contributing to SpaceGuard! SpaceGuard is an open-source project dedicated to providing lightweight disk space and dependency management for Debian, Kali Linux, Ubuntu, and macOS systems.

How to Contribute

1. Reporting Bugs

  • Search existing issues to ensure the bug hasn't been reported yet.
  • Open a new issue with a clear title, description, steps to reproduce, and your system environment (e.g., Debian 12, Kali 2024.1, macOS Sequoia / Sonoma).

2. Suggesting Enhancements

  • Feature requests are welcome! Please open an issue outlining the motivation and proposed implementation.

3. Pull Requests

  1. Fork the repository on GitHub: https://github.com/MutantMonx/SpaceGuard.git.
  2. Create a feature branch: git checkout -b feature/my-new-feature.
  3. Commit your changes with descriptive commit messages.
  4. Test your changes locally (npm run lint and npm run build).
  5. Push to your branch and submit a Pull Request.

Code Style

  • Use TypeScript with strict type safety where possible.
  • Use Tailwind CSS for utility styling matching the geometric cyberpunk/terminal aesthetic.
  • Ensure all user-facing strings are added to src/utils/translations.ts for EN/PL localization.

License

By contributing to SpaceGuard, you agree that your contributions will be licensed under the Apache License 2.0.