Thank you for considering contributing to MISOReports! We’re excited to have your support, and we welcome any feedback, bug reports, and improvements. This guide provides a quick overview of how you can contribute to the project.
There are several ways you can get involved:
Before opening a new issue, please search to see if one already exists. If not, feel free to open a new issue and provide as much detail as possible.
If you encounter any bugs, please let us know! To make your bug report as effective as possible, please include:
- A clear and descriptive title for the issue
- Steps to reproduce the bug
- The expected vs. actual behavior
- Screenshots, error messages, or code snippets if applicable
- Environment details
You can report bugs by opening an issue. We’ll do our best to address them as soon as possible
We’re always open to new ideas! If you have a feature in mind that would improve the project, please suggest it by:
- Opening a feature request issue
- Describing the feature clearly, including why it would be beneficial
- Sharing any examples or references that can help us understand your idea
If you'd like to make changes to the code, please follow these steps:
- Fork the repository and create a new branch.
- Make your changes, ensuring that they are focused and well-documented. Please write code in a style similar to that of the codebase for consistency.
- Test your changes to make sure everything works as expected.
- Submit a pull request with a clear description of your changes and link to any related issues.
We welcome pull requests for:
- Fixing bugs
- Implementing new features
- Improving documentation
- Enhancing existing code for performance or readability
When submitting a pull request, make sure to:
- Describe the problem your changes address or the feature they add
- Reference any related issues by number (e.g.,
#123) - Keep changes focused on a single improvement or fix
Thank you for your interest in contributing! We’re excited to work with you to make MISOReports better for everyone.