Merge pull request #32 from amq92/amq92-patch-contributing

Amq92 patch contributing

CONTRIBUTING

@@ -0,0 +1,38 @@
+# Contributing to Simple Slurm
+
+We welcome contributions! Before submitting changes, please follow these guidelines:
+
+## Reporting Issues
+- Check existing issues to avoid duplicates.
+- Include a **minimal reproducible example** for bugs.
+- If possible specify your Slurm cluster setup (*e.g.*, Slurm version, Linux distro).
+
+## Submitting Pull Requests
+1. **Fork the repository** and create a feature branch.
+   ```bash
+   git checkout -b my-feature
+   ```
+3. Ensure code passes:
+   ```bash
+   ruff check .            # Linting
+   ruff format .           # Formatting
+   python -m unittest -v   # Run unit tests
+   ```
+4. Test/validate changes (see [Testing](#testing)).
+5. Update documentation if needed.
+6. Open a PR with a clear description of changes and test results.
+
+## Code Style
+- Format code with [`ruff`](https://docs.astral.sh/ruff/).
+- Add type hints for new functions/methods.
+- Keep docstrings consistent with existing code.
+
+## Testing
+- Testing on a real Slurm cluster is **highly desired**.
+- Add unit tests to validate any change in functionality.
+
+## Questions?
+- Open a GitHub issue.
+- Tag [`@amq92`](https://github.com/amq92) in the discussion.
+
+Thank you for helping improve Simple Slurm! 🚀

README.md

@@ -10,9 +10,6 @@
 <a href="https://github.com/amq92/simple_slurm/actions/workflows/python-run-tests.yml">
     <img src="https://github.com/amq92/simple_slurm/actions/workflows/python-run-tests.yml/badge.svg" alt="Run Python Tests" />
 </a>
-<a href="LICENSE">
-    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" />
-</a>
 </p>
 
 ```python
@@ -70,8 +67,6 @@ EOF
    - [Monitoring Jobs with `squeue`](#monitoring-jobs-with-squeue)
    - [Canceling Jobs with `scancel`](#canceling-jobs-with-scancel)
 + [Error Handling](#error-handling)
-+ [Contributing](#contributing)
-+ [License](#license)
 + [Project Growth](#project-growth)
 
 
@@ -407,17 +402,5 @@ simple_slurm: error: unrecognized arguments: --invalid_argument=value
 ```
 
 
-## Contributing
-Contributions are welcome! Please follow these steps:
-
-1. Fork the repository.
-2. Create a new branch for your feature or bugfix.
-3. Submit a pull request with a detailed description of your changes.
-
-
-
-## License
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
-
 ## Project growth
 [![Star History Chart](https://api.star-history.com/svg?repos=amq92/simple_slurm&type=Date)](https://star-history.com/#amq92/simple_slurm&Date)