Thanks for taking the time to contribute to pyGSTi! Open-source projects like ours couldn't exist without contributors like you.
This document contains a set of guidelines for contributing to pyGSTi and related packages hosted under the pyGSTio group. We ask that contributors make an earnest effort to follow these guidelines, but no one's keeping score here -- just use your best judgement, and by all means, feel free to propose changes to these guidelines in a pull request.
Found a bug in pyGSTi? We'd appreciate letting us know!
-
First, see if the bug has already been reported by searching on Github under Issues.
-
If you can't find an open issue about the problem, open a new one! Be sure to include a title, a clear description of what went wrong, and as much relevant information as possible. If you can, try to include detailed steps to reproduce the problem.
-
Once you open an issue, please keep an eye on it -- you may be asked to provide more details.
Want to add a new feature or change an existing one?
-
First, see if the feature or enhancement has already been suggested by searching on Github under Issues.
-
If you can't find a similar suggestion in the issue tracker, open a new issue for your feature suggestion.
Want to fix a bug, add a feature, or change an existing feature?
Because pyGSTi is a project of the Quantum Performance Lab at Sandia National Labs, the process of contributing to pyGSTi is different for contributors working at Sandia.
Unfortunately, we can't currently accept pull requests from contributors outside of SNL. We're working on setting up a contributor license agreement, so, someday, this may change. If you're interested in making contributions please let us know by email at pygsti@sandia.gov so we can make a strong case to our lawyers for getting this done!
-
Contact the authors at pygsti@sandia.gov to request an invite to the pyGSTio group.
-
Follow the guidelines on the project wiki.