Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 2.85 KB

Contributing

Hi, thanks for showing an interest in lua-widow-control!

Questions

If you have a more question about lua-widow-control, then open a new Discussion. This is the place for usage and general questions. Some important guidelines:

  • Search through the list of discussions to make sure that there isn't already an identical discussion. If you find an identical discussion, then don't open a new one. Instead, add a comment to the preexisting discussion.

  • Please place bug reports and feature requests in the issues section.

Bug Reports

If you have any issues with lua-widow-control, please open an issue. Some important guidelines:

  • Search through the list of issues to make sure that someone else hasn't already reported the issue. If you see that your issue has already been reported, then don't open a new issue. Instead, add a comment to the preexisting issue.

  • Please use the bug report template! It makes sure that I have all the information needed to reproduce and solve the bug.

  • Provide as much information as possible. The best way to do so is to include an MWE and a complete log file.

  • Please place questions in the discussions section.

Feature Requests

Follow the same instructions as for bug reports. Please note that while I will for sure consider all feature requests, I make no promises on implementing them.

Code and Documentation Contributions

I greatly appreciate any direct contributions to lua-widow-control via Pull Requests. Some guidelines:

  • Feel free to work on any of the listed issues or any ideas of your own. Just make sure that there isn't already an open pull request and that it isn't marked as "In Progress".

  • Each file should list its licence in its header. I will assume that you agree to licence your contributions under the listed licences.

  • Lua-widow-control supports Plain TeX, LaTeX, ConTeXt, and OpTeX, so make sure that your changes work for all formats.

Thank you!