Contributing to GreatX

October 27, 2022 · View on GitHub

If you are interested in contributing to GreatX, your contributions will likely fall into one of the following two categories:

You want to implement a new feature:
- In general, we accept any features as long as they fit the scope of this package. If you are unsure about this or need help on the design/implementation of your feature, post about it in an issue.
You want to fix a bug:
- Feel free to send a Pull Request any time you encounter a bug. Please provide a clear and concise description of what the bug was. If you are unsure about if this is a bug at all or how to fix, post about it in an issue.

Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/EdisonLeeeee/GreatX.

Developing GreatX

To develop GreatX on your machine, here are some tips:

Uninstall all existing GreatX installations:

pip uninstall greatx
pip uninstall greatx  # run this command twice

Clone a copy of GreatX from source:

git clone https://github.com/EdisonLeeeee/GreatX
cd GreatX

If you already cloned GreatX from source, update it:
```
git pull
```
Install GreatX in editable mode:
```
pip install -e ".[dev,full]"
```
This mode will symlink the Python files from the current local source tree into the Python install. Hence, if you modify a Python file, you do not need to reinstall GreatX again and again.
(TODO) Ensure that you have a working GreatX installation by running the entire test suite with
```
pytest
```
Install pre-commit hooks:
```
 pre-commit install
```

The GreatX testing suite is located under test/. Run the entire test suite with

pytest

or test individual files via, e.g., pytest test/utils/test_convert.py.

To build the documentation:

Install Sphinx theme via

pip install git+https://github.com/pyg-team/pyg_sphinx_theme.git

The documentation is now available to view by opening docs/build/html/index.html.