Contributing#

Luster is currently not a mature library and is undergoing heavy development. In this scenario, Any contribution is plays an important role in progress of this library. So, Thank you for showing interest in contributing to Luster.

Bug reports, feature requests should be submitted using GitHub issues tracker and code contributions should be done using GitHub Pull Requests

Major Changes#

When making major changes such, Make sure to discuss your change within our Revolt Server. Pull requests that implement a major change without any prior disussion will not be accepted.

Make sure to keep the scope of your pull request small and limited. Do not make multiple changes in one pull request.

Common Conventions#

Following are general conventions for Luster source code:

  • Type checking: Luster is a typed library. When contributing and modifying the source code, It is important to use a type checker to ensure that there are no typing issues in the code.

  • Docstrings: Docstrings are written in Numpy and Google format. See sphinx.ext.napoleon documentation for more information.

  • Formatting: The source code must be formatted properly according to Python formatting conventions as described in PEP-8. There’s currently no specific automatic formatter used by this project.

Revolt Server#

If you have got any questions, We highly suggest joining our official Revolt Server. Feel free to ask any questions or discuss your bug report, feature request or code change.