pygfunction welcomes and appreciates bug reports, suggestions and contributions from everyone.
This guide describes how to report bugs, suggest new features and contribute code to pygfunction.
Bugs are reported on the issue tracker.
Follow these steps when submitting a bug report:
- Make sure the bug has not been already reported. Run a quick search through the issue tracker. If an open issue is related to your problem, consider adding your input to that issue. If you find a closed issue related to your problem, open an new issue and link to the closed issue.
- Use a short and descriptive title when creating a new issue.
- Provide detailed steps to reproduce the problem. Explain, in details, how to reproduce the problem and what should be the expected result. When possible, include a simple code snippet that isolates and reproduces the problem.
After submitting a bug report, if you wish to contribute code to fix the problem, follow the steps outlined in the contribution workflow.
This section outlines the steps for contributing to pygfunction. This workflow
is inspired by Trunk Based Development, with
short-lived feature branches and releases from tags on the master.
- Open a new issue.
- Use a short and descriptive title. When proposing an enhancement, describe in details what the enhancement would entail. If you plan to implement the enhancement yourself, provide a step-by-step plan for the implementation.
- Explain how the enhancement benefits pygfunction.
- Create (checkout) a new branch from the
master. The branch name should follow the naming convention:issue#_shortDescription. For example: issue1_loadAggregation. - Implement unit tests for new features. If necessary, update already implement tests to cover the new features.
- Before submitting a pull request, merge the master to your branch.
- Once the branch is merged, delete the branch and close the issue.
pygfunction follows the PEP8 style guide. Docstrings are written following the numpydoc format, see also an example here.