Contributing to ProcessPI

We welcome contributions from the community! 🎉
Help make ProcessPI more powerful and versatile by joining the development process.

How to Contribute

Fork & Clone
Fork the repository on GitHub and clone your fork locally to start working.
Create a Branch
```
git checkout -b feature/your-feature-name
```
Work in a separate branch for your feature or bug fix.
Implement Changes
Add your code, unit tests, and documentation updates. Follow PEP8 style and type hints.
Run Tests
Ensure all tests pass and your changes integrate cleanly.
Push & Pull Request
```
git push origin feature/your-feature-name
```
Open a PR on the main repository with a clear description.
Report Issues
Found a bug or have a feature idea? Open an issue on GitHub with steps to reproduce or a detailed proposal.

Test Existing Examples
Validate pipeline, network, and calculation examples by running them and reporting discrepancies.
Submit Real-World Cases
Share process problems, network designs, or calculation scenarios that can enhance our test suite.
Enhance Functionality
Propose improvements to the engine, add new fittings, fluids, or calculation methods.
Edge Cases & Validation
Test unusual pipe diameters, extreme flow conditions, or multi-branch networks and report outcomes.

PEP8 Compliance
Maintain consistent coding standards.
Docstrings & Typing
Document public functions and classes with clear docstrings; use type hints when possible.
Best Practices
Keep code modular, readable, and maintainable. Write tests for new features.

Thank you for helping improve ProcessPI! 💡