Contact#

We’d love to hear from you — whether you have a question, found a bug, or want to contribute. Here’s the best way to reach us depending on what you need.

Getting Help#

For installation and release information, the PAOFLOW PyPI project page is a good first stop.

For everything else, GitHub Discussions is the place to be. Come say hello, ask questions, share how you’re using PAOFLOW, or get advice on best practices. No question is too basic — we’re happy to help.

Bug Reports and Feature Requests#

Found something that doesn’t work as expected? Have an idea for a new feature? We track both through GitHub Issues.

Before opening a new issue, a quick search of existing ones can save you time — someone may have already reported the same thing or started a useful discussion. Once you’ve confirmed it’s new, go ahead and open an issue and we’ll take a look.

Contributing#

PAOFLOW is an open project and contributions of all kinds are welcome — code, documentation, examples, bug reports, and feedback. We follow a discussion-first approach to make sure effort is well spent.

  1. Find or open an issue for what you want to work on.

  2. Comment with your intended approach and get feedback from maintainers.

  3. Once the direction is agreed, start implementing.

  4. Open a Pull Request referencing the issue when ready.

Starting with a conversation before diving into code helps avoid situations where a lot of work goes in a direction that doesn’t fit the project roadmap.

Development Guidelines#

The Internals section has everything you need to get set up and contribute effectively: