From 8a55054f072476f9d476865be6eea1c38eac5550 Mon Sep 17 00:00:00 2001 From: Xiangyu Hu Date: Tue, 2 Jul 2024 14:08:05 +0000 Subject: [PATCH 1/2] promoting issue report --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 917aa9ed07..c91c70a01c 100644 --- a/README.md +++ b/README.md @@ -112,22 +112,29 @@ For installation, program manual and tutorials, please check . For a Docker image, check . -## Get involved to SPHinXsys +## Interaction with SPHinXsys and the team -Thank you for using and supporting our open-source project! We value all feedback and strive to improve our codebase continuously. +Thank you for using and supporting our open-source project! +We value all feedbacks. -As the code is on git-hub, you can register an account there (if you do not have a github account yet) -and fork out the SPHinXsys repository. -You can work on the forked repository and add new features, and then commit them. -You can also initiate a pull request to the main repository, -so that your new features can be merged into it. +#### For SPHinXsys users: -To ensure efficient and effective development, we prioritize addressing issues and pull requests from those who actively contribute to the project. Your contributions, whether through code, documentation, or other means, help us maintain and enhance the project for everyone. -We encourage all users to consider contributing in any way they can. Together, we can build a better, more robust software. +Your input is crucial to us. We encourage you to report any issues you encounter with the library, including: +* Bug reports +* Poorly written code or algorithm designs +* Benchmark test issues, whether within the library or from literature, especially those highlighting potential deficiencies -You are also welcomed to join the main repository as a collaborator, -by which you are able to branch directly in the main repository, -and review the pull request. +We particularly appreciate feedback stemming from practical simulations or projects, as these insights are essential for improving SPHinXsys. -If you have any further question, you are also welcomed to contact . +#### For SPHinXsys Developers: + +If you don't have a GitHub account yet, please register for one. Fork the SPHinXsys repository to add new features or improve existing ones. Once your changes are ready, commit them and initiate a pull request to have your contributions merged into the main repository. + +To ensure efficient and effective development, we prioritize addressing issues raised by active contributors—whether through code, documentation, or other means. We welcome any interaction with SPHinXsys and our team. + +You can also join us as a collaborator, enabling you to branch directly within the main repository and review pull requests. + +Together, we can build a leading-edge multi-physics library open for all! + +If you have any further question, please contact . From cd3213e621b807043df4d915caebac6893c6616d Mon Sep 17 00:00:00 2001 From: Xiangyu Hu Date: Tue, 2 Jul 2024 14:14:36 +0000 Subject: [PATCH 2/2] add other issues --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c91c70a01c..e500465a7f 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,7 @@ Your input is crucial to us. We encourage you to report any issues you encounter * Bug reports * Poorly written code or algorithm designs * Benchmark test issues, whether within the library or from literature, especially those highlighting potential deficiencies +* Other issues We particularly appreciate feedback stemming from practical simulations or projects, as these insights are essential for improving SPHinXsys.