65 lines (44 loc) · 1.71 KB

Contributing to Proc-Monitor

First off, thank you for considering contributing to Proc-Monitor! 🎉

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues. When creating a bug report, include:

Clear title describing the issue
Steps to reproduce the behavior
Expected behavior vs actual behavior
System information: OS, Python version, etc.
Error messages or logs if applicable

Suggesting Enhancements

Enhancement suggestions are welcome! Please include:

Clear title describing the suggestion
Detailed description of the proposed feature
Use case explaining why this would be useful
Possible implementation if you have ideas

Pull Requests

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Test your changes on a Linux system
Commit with clear messages (git commit -m 'Add amazing feature')
Push to your branch (git push origin feature/amazing-feature)
Open a Pull Request

Code Style

Follow PEP 8 for Python code
Use clear, descriptive variable names
Add docstrings to functions
Keep functions focused and small
No external dependencies! Use only Python standard library

Testing

Before submitting:

Test on a Linux system with /proc filesystem
Test with and without root privileges
Test with and without config.json
Verify JSON report generation

Documentation

Update README.md if adding features
Update usage guides (USAGE_EN.md, USAGE_TR.md) for user-facing changes
Update CHANGELOG.md with your changes

Questions?

Feel free to open an issue for any questions!

Thank you for contributing! 🙏