Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (52 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 1.97 KB

Contributing to System Monitor

Thank you for your interest in contributing to System Monitor! We welcome contributions from everyone.

How to Contribute

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Test your changes
  5. Commit your changes: git commit -m 'Add some feature'
  6. Push to the branch: git push origin feature/your-feature-name
  7. Submit a pull request

Code Style

  • Follow PEP 8 for Python code
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Include:

  • A clear description of the issue
  • Steps to reproduce (if applicable)
  • Your system information
  • Any relevant logs or screenshots

Testing

Before submitting a pull request, please test your changes thoroughly. Run the monitor and ensure it works as expected.

🚀 Contributing to the .NET/C# Integration

We're building a future version with C#/.NET Core web dashboard for remote server monitoring. This is a great opportunity to contribute across multiple stacks:

Areas for Contribution:

  1. Linux/Python Backend

    • Expand system metrics collection
    • Add performance profiling
    • Implement custom plugins

  2. C#/.NET Web Dashboard

    • ASP.NET Core web API
    • Real-time WebSocket integration
    • Modern frontend (React/Vue)
    • Multi-server management UI

  3. Documentation & Testing

    • Integration tests between Python and .NET
    • Architecture documentation
    • Tutorial videos

Technology Stack (Planned):

Frontend: React/Vue.js + TypeScript
Backend:  ASP.NET Core 8+
Database: PostgreSQL
Messaging: RabbitMQ/SignalR
Monitoring: Prometheus/Grafana integration

If you're interested in helping with the .NET integration, please open a discussion on GitHub!

Code of Conduct

Please be respectful and inclusive in all interactions.