Thank you for your enthusiasm and generosity in wanting to contribute to the project!
We kindly ask you to follow the guidelines hereby specified.
Bugs are tracked via GitHub issues. The issue template will help you on the way to create a new one:
- Create an issue via the issues list
- Include the versions of MiniExcel that are affected
- Specify the target framework and operating system
- Describe the differences between the expected behaviour and the actual behaviour
- Provide a minimum code sample that reproduces the issue
Similarly, feature requests are also tracked via GitHub issues. The issue template will help you on the way once again:
- Create an issue via the issues list
- Explain your motivations for the feature to be included
- Describe how the feature would work
- Include workarounds where applicable
Please do not open a PR that does not reference an issue.
- If an issue does not already exist please create one via the issues list
- Fork the repository and create a branch with a descriptive name
- Attempt to make commits of logical units
- Verify the solution builds successfully and all tests pass
- Create the PR making sure:
- It references the issue addressed by the PR
- Unit tests for the changes have been added
- Documentation has been updated where necessary
The use of AI agents is allowed for generating bugfixes, unit tests and documentation. Please make sure to review all AI contributions submitted on your behalf.
We kindly ask you to refrain from using AI to generate new features, as it becomes increasingly difficult and time-consuming for the maintainers to review them, integrate them appropriately into the codebase, and ultimately maintain them indefinitely.
Feel free to open a discussion or contact the maintainers directly via email if you have further inquiries.
Finally, when contributing please keep in mind our Code of Conduct.