Contributing

Contributing to pyGSTi

The pyGSTi project uses a simple & flexible branching git workflow. Members of the pyGSTio group should use this document as a guide to making contributions to the pyGSTi codebase.

These guidelines do not apply to contributors outside of the pyGSTio group. If you're an external contributor to pyGSTi, please refer to the general contributor guidelines.

Contents

Workflow

• Setting Up a Development Environment
• Clone the pyGSTi Repository
• Install Development Dependencies
• Write Your Code
• Running Tests
• Commit Your Changes
• Update Your Branch
• Submit a Pull Request
• Get some Feedback

Documentation

• Code & API Documentation
• User Guides & Tutorials
• Developer Wiki
• Publications

Conventions

• Repository
• Style
  • Code Style
  • Docstring Style
• Organization
• Testing

Workflow

This section is a step-by-step guide to contributing code to the pyGSTi project. You don't need to follow these steps to make a contribution to pyGSTi, but if you're not sure how to use the guidelines and conventions of the project, you might want to check the relevant heading in this section.

Setting Up a Development Environment

TODO

Clone the pyGSTi Repository

TODO

Install Development Dependencies

TODO

Write Your Code

TODO

Running Tests

TODO

Commit Your Changes

TODO

Update Your Branch

TODO

Submit a Pull Request

TODO

Get some Feedback

TODO

Documentation

We rely on our contributors to keep our documentation correct, constistent, usable, and up-to-date. If you have additions or corrections to add to our project's documentation, we have a couple of resources available to you.

Code & API Documentation

TODO

User Guides & Tutorials

TODO

Developer Wiki

TODO

Publications

TODO

Conventions

This section details a few of the common development conventions followed by pyGSTi developers. These are not absolute requirements for contributing, but in some rare cases, contributions to the codebase may be temporarily rejected for breaking from conventions. We really appreciate contributors making an effort to follow these conventions and keep our codebase clean, clear, and maintainable.

Repository

TODO

Style

TODO

Code Style

TODO

Docstring Style

TODO

Organization

TODO

Testing

TODO