Contributing - sile-typesetter/sile GitHub Wiki

Your participation is vital for our community to thrive and evolve. You're encouraged to contribute, and your input and collaboration are highly valued.

Below are some non-binding contribution guidelines to assist you.

Regarding questions

In addition to issue reports, there are several avenues for engaging in discussions:

Regarding new issues and PRs

We welcome your Pull Requests (PRs) with pleasure.

However, it's often beneficial to initiate an issue or discussion beforehand and to gather insights and advice before submitting a PR.

Regarding new commands or packages

The addition of new commands or improvements to existing ones are welcome, especially if they offer broad utility. For new core packages, especially those that enhance core typesetting functions and provide solid building blocks for specialized applications, we are all ears.

While we generally prefer to avoid highly specialized packages or those that introduce external dependencies, we are open to considering proposals.

Even if a proposal or submission isn't deemed suitable for inclusion in the core distribution, we might be willing to host semi-official packages in the SILE organization and publish them through official channels. This helps foster a vibrant third-party ecosystem where useful tools are readily available for setup and use.

In essence, don't hesitate to ask yourself if a change merits inclusion in the core distribution. If not, it could still be a valuable addition as a third-party package within our ecosystem.

Speaking of the ecosystem, be sure to explore our Luarocks manifest for existing third-party packages. They may also welcome enhancements and contributions.

Regarding existing issues

We have a wealth of feature requests and known bugs awaiting attention. Your contributions can make all the difference!

Additionally, we have organized some issues into projects, which you can explore here. Furthermore, from time to time, we have discussions regarding our goals for milestones, such as the one outlined in this issue.