Contributing as a user#
Users can contribute in a variety of ways, such as reporting bugs, requesting new features, testing in-development features, starting discussions, answering questions, and sharing their work with the community.
Warning
Do not include any proprietary or sensitive information when reporting bugs or showcasing your work.
Found a bug? Report it here.
Got an idea for a new feature? Share it!
Anxious to try out a new feature? Here’s how you can do it.
Want to discuss something? Start a discussion here.
Help others by answering their questions.
Share your work with the community.
Report bugs#
If you encounter a bug or an issue while using the project, report it. Your feedback helps to identify problems.
Search the PyMechanical issue to see if the issue has already been reported.
Create a new issue if it hasn’t been reported.
Include a clear description of the problem.
Provide steps to reproduce the issue.
Mention the version of the project you’re using.
Include screenshots or logs if possible.
Request a new feature#
Do you have an idea for a new feature or an improvement? Your suggestions are welcome. You can request a new feature by creating an issue in the PyMechanical issue board.
Test a new feature#
It is possible to test a new feature before it is officially released. To do so, you can install PyMechanical from the source code.
git clone https://github.com/ansys/pymechanical.git
cd pymechanical
pip install -e .
Start a discussion#
Complex topics may require a discussion. Whether you want to know how to use PyMechanical for solving your specific problem or you have a suggestion for a new feature, a discussion is a good place to start. You can open a new discussion in the PyMechanical discussion section.
Answer questions#
Another great way to contribute is to help others by answering their questions. Maintain a positive and constructive attitude while answering questions. If you don’t know the answer, you can still help by pointing the person in the right direction.