Skip to content

Support & Contributing

For bugs, feature requests, and improvements, please open an issue in the GitHub Issues page for PyNNLF. For general support questions, contact m.samhan@unsw.edu.au.

Code of Conduct

By participating in this project, you agree to communicate respectfully and constructively, welcome diverse perspectives, avoid harassment or abusive behavior, and help maintain a professional, inclusive environment; maintainers may moderate discussions and contributions that do not meet this standard.

Possible Contributions

  • Report bugs such as code logic flaws, runtime errors, and unclear documentation.
  • Request new features, especially for net load forecasting researchers and industry practitioners working on net load forecasting.
  • Contribute new datasets by following the guide in How to add a dataset.
  • Contribute new models by following the guide in How to add a model.
  • Improve documentation, tests, and examples.

How to Open a GitHub Issue

Create an issue in GitHub and include the key details below so maintainers can triage it quickly. Please add at least one label when you open the issue, for example: bug, enhancement, documentation, dataset, or model.

Issue Template (Copy and Paste)

### Issue type
(Bug report / Feature request / Documentation improvement / Dataset contribution / Model contribution)

### Label(s) added
(e.g., bug, enhancement, documentation, dataset, model)

### Issue observed
(Describe what is happening now. For bugs, include the error/incorrect behavior.)

### Expected change / expected feature
(Describe what should happen instead or the feature you want.)

### Steps to reproduce or context
(Include dataset ID, model ID, forecast horizon, environment, and steps if relevant.)

### Why this matters
(Explain impact for users, researchers, or industry practice.)