Contributing#

Before contributing to a PyAnsys repository, you must understand the general coding paradigms being used for PyAnsys development.

  1. Follow the Zen of Python. As silly as core Python developers are sometimes, there’s much to be gained by following the basic guidelines listed in PEP 20. As suggested in these guidelines, focus on making your additions intuitive, novel, and helpful for PyAnsys users. When in doubt, use import this. For Ansys code quality standards, see Coding style.

  2. Document your contributions. Include a docstring for any added function, method, or class, following Numpydoc docstrings as specified by PyAnsys Documentation style. Always provide at least one simple use case for a new feature.

  3. Test your contribution. Because Python is an interpreted language, if it’s not tested, it’s probably broken. At the minimum, include a unit test for each new feature within the tests directory. Ensure that each new method, class, or function has a reasonable (>80%) coverage. For information about automated testing, see Testing.

  4. Do not include any datasets for which a license is not available or commercial use is prohibited.

  5. Review the Ansys Code of Conduct.

All PyAnsys projects are hosted in GitHub in the form of Git repositories. GitHub is a platform that not only provides storage for projects but also additional features like code reviews or issue boards.


Create a GitHub account#

To use GitHub, start by creating an account for the platform. Follow the GitHub Join Process. If you require access to the PyAnsys Organization, email pyansys.support@ansys.com.

GitHub repository sections#

Once you have a GitHub account and access to the PyAnsys organization, you are able to interact with the different repositories. While each repository contains all tabbed sections that are shown and described below, your access level determines tabbed sections you can see.

GitHub repository sections
  • Code: Tree view of the project’s structure

  • Issues: Posts noting issues or requesting new features

  • Pull requests: Code changes either awaiting review or merging or already closed

  • Discussions: Exchanges about development practices with project maintainers

  • Actions: Available CI/CD workflows

  • Projects: Plans for organizing and developing the repository

  • Wiki: Basic project information

  • Security: Configurations related to security issues, vulnerabilities, and alerts

  • Insights: General information about the repository and its contributors

  • Settings: Configurations for access and integration with third-party tools

Create an issue#

You create an issue to either report a bug or request help or a new feature. Commenting allows you to interact with other users, developers, and project maintainers.

To open an issue, select the Issues tab in the GitHub repository sections and click New Issue. Then, select a template for the type of issue to open.

GitHub issues require the usage of Markdown files instead of ReStructured Text files. For more information, see Basic writing and formatting syntax.

Request new features#

If you would like a new feature to be added to a PyAnsys library, you open a new issue and select either the template for code enhancements or a feature idea. In the issue, you then do the following:

  • Describe the main goal of the feature that you’d like to have added and why it is beneficial to the project.

  • Describe how this feature might possibly be implemented and the steps that should be followed.

  • Add any references that could help during the development process.

Report bugs#

If you encounter a bug in the code, you open a new issue and select the template for creating a bug report. In the bug report, try to:

  • Indicate the operating system, Python version, and library version that you are using.

  • Include a small piece of code to allow others to reproduce the bug you found.

  • Add any additional information that you consider useful for fixing the bug.

Fork a repository#

Forking a repository is like copying and pasting a project into your own GitHub profile. Notice that only public labeled repositories can be forked. You cannot fork a repository labeled as internal or private.

To fork a repository, click the Fork button at the top of the project’s Code tabbed section.

Clone a repository#

Cloning a repository means downloading it to your local machine. While there are two ways of doing this (HTTPS or SSH), to force the usage of SSH, only this method is explained.

Clone using SSH#

Cloning using SSH requires Enabling SSH. After that, you can clone a repository by running:

git clone git@github.com:<user>/<repository-name>.git

For example, clone the PyMAPDL project with:

git clone git@github.com:pyansys/pymapdl.git

Install in editable mode#

You can install a Python library in editable mode, which allows you to modify the source code and have these new changes reflected in your Python environment.

To install a Python library in editable mode:

  1. Ensure that you Create and Activate a Python virtual environment, as explained in the Virtual environments section.

  2. Update pip with:

    python -m pip install --upgrade pip
    
  3. Install the library with:

    python -m pip install --editable .
    

Create a branch#

It is likely that the default branch name is main or master. This is the development branch for PyAnsys projects. For more information, see Branch model.

You must implement new contributions in a different branch and then Create a pull request so that you can merge these changes into the main branch.

You create a branch with:

git checkout -b <new branch name>

Branch naming conventions#

The following requirements for naming branches helps to streamline development. They help core developers know what kind of changes any given branch is introducing before looking at the code.

  • fix/: Bug fixes, patches, or experimental changes that are minor

  • feat/: Changes that introduce a new feature or significant addition

  • junk/: Experimental changes that can be deleted if they go stale

  • maint/: General maintenance of the repository or CI routines

  • doc/: Changes pertaining only to documentation

  • no-ci/: Low-impact activity that should not trigger CI routines

  • testing/: Improvements or changes to testing

  • release/: Releases (see below)

Push a new branch#

Once you have implemented new changes and committed them, you push your branch, which uploads your changes to the repository. These changes are only visible in the branch that you just pushed.

git push -u origin <new branch name>

Create a pull request#

Once you have tested your branch locally, create a pull request (PR) and target your merge to main. This automatically runs CI testing and verifies that your changes work across all supported platforms. For procedural information, see Creating a pull request in the GitHub documentation.

After you submit your PR, someone from the PyAnsys development team reviews your code to verify that it meets the Packaging style, Coding style, and Documentation style.

Once your code is approved, if you have write permission, you can merge the PR and then delete the PR branch. If you don’t have write permission, the reviewer or someone else with write permission must merge your PR and then delete your PR branch.

Always delete your PR branch after merging it into the main branch.

You can set up automatic deletion of branches in Settings -> General -> Pull Requests.

Use GitHub CLI#

Because developers do not like leaving their terminals when working in projects, GitHub offers a command-line interface (CLI).

This program allows you to interact with most of the features available in the web version of GitHub. For available commands, see the official GitHub CLI manual.