How to contribute to PhasicFlow

We welcome contributions to PhasicFlow! Whether you're a seasoned developer or a new user, there are many ways to get involved. Here's how you can help:

Ways to Contribute

1. Bug Reports

If you encounter a bug, please help us fix it by submitting a detailed bug report.

• Open a new issue: Open a new issue in the repository to report the bug.
• Check for existing issues: Before submitting a new issue, please search the existing issues to see if your bug has already been reported.
• Provide clear steps to reproduce: Include detailed steps that allow us to reproduce the bug.
• Include relevant information: Specify your operating system, Python version, PhasicFlow version, and any other relevant information.
• Use descriptive titles: Use clear and concise titles for your bug reports.

2. User Experience (UX) Improvements

Your feedback on the usability of PhasicFlow is valuable. Open a new discussion in the Discussions section for your feedback. Consider these:

• Suggest improvements: If you have ideas for improving the user interface, command-line interface, or documentation, please share them.
• Provide specific examples: Illustrate your suggestions with concrete examples or screenshots.
• Explain the benefit: Describe how your suggestion will improve the user experience.

3. Feature Requests and Algorithm Improvements

We're always looking for ways to enhance PhasicFlow. For feature request:

• Suggest new features: If you have ideas for new features, please submit a feature request.
• Propose algorithm improvements: If you have suggestions for improving the algorithms used in PhasicFlow, please share them.
• Provide theoretical backing: If possible, provide theoretical justification or references for your suggestions.
• Clearly define the scope: Describe the feature or improvement in detail, including its intended use and benefits.

4. Tutorials and Simulation Case Setups

Sharing your simulation setups and tutorials can help others learn and use PhasicFlow effectively. In the Discussions section open a new thread for your proposal and we can discusse it there.

• Create tutorials: Write tutorials that explain how to use PhasicFlow for specific applications.
• Provide simulation case setups: Share simplified simulation case setups that demonstrate the capabilities of PhasicFlow.
• Include clear instructions: Provide clear and concise instructions on how to run the simulations.
• Document your work: Document your tutorials and simulation setups thoroughly.

5. Direct Code Contributions

We encourage direct code contributions to add new features and improve the robustness and efficiency of PhasicFlow. For code contribution, direcelty contact us for more discussion and coordination. The code contribution may involve the following steps:

• Fork the repository: Fork the PhasicFlow repository to your GitHub account.
• Create a branch: Create a new branch for your changes.
• Follow coding guidelines: Adhere to the coding style and guidelines used in the project.
• Write tests: Write unit tests for your code.
• Submit a pull request (PR): Submit a pull request with a clear description of your changes.
• Discuss your changes: Be prepared to discuss your changes and address any feedback from the maintainers.
• Ensure mutual need: When adding a feature, please ensure that it is of mutual need for the community and not just a very niche application.
• Focus on robustness and efficiency: When improving algorithms, focus on enhancing their robustness and computational efficiency.
• Document your code: Add comments and documentation to your code.

Getting Started

1. Fork the repository: Click the "Fork" button on the GitHub repository page.

2. Clone your fork: Clone your forked repository to your local machine.

   git clone [https://github.com/your-username/phasicFlow.git](https://github.com/your-username/phasicFlow.git)

3. Create a branch: Create a new branch for your changes.

   git checkout -b feature/your-feature-name

4. Make your changes: Make the necessary changes to the code.

5. Commit your changes: Commit your changes with clear and descriptive commit messages.

   git add .
   git commit -m "Add feature: your feature description"

6. Push your changes: Push your changes to your remote branch.

   git push origin feature/your-feature-name

7. Submit a pull request: Create a pull request from your branch to the main branch of the PhasicFlow repository.

Community

• GitHub Issues: Use GitHub issues for bug reports, feature requests, and general discussions.
• Discussions: If available, use the GitHub Discussions tab for general questions and discussions.

We appreciate your contributions to PhasicFlow!