mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-04-28 05:36:46 +00:00
45 lines
2.8 KiB
Markdown
45 lines
2.8 KiB
Markdown
---
|
|
title: Contributing to InvenTree
|
|
---
|
|
|
|
## Contribute to InvenTree
|
|
|
|
InvenTree is an open source project, and benefits greatly from user contributions.
|
|
|
|
If you find InvenTree to be useful, and wish to improve the software, please consider contributing:
|
|
|
|
### Source Code
|
|
|
|
InvenTree is built using [Python3](https://www.python.org/) and [Django](https://www.djangoproject.com/). Source code is available on [GitHub](https://github.com/inventree/inventree).
|
|
|
|
Contributions towards the core InvenTree code base are welcomed; either extending current functionality, prodiving new features, or addressing outstanding issues.
|
|
|
|
### Report Bugs
|
|
|
|
If you find a bug or a feature that does not work correctly, please report it on [GitHub](https://github.com/inventree/inventree/issues). Reporting bugs is critical to improving the software. If you are able and willing, providing a fix for any outstanding issues would be greatly appreciated.
|
|
|
|
### Translation
|
|
|
|
InvenTree provides a translation layer for both the web interface and mobile app. Native language translation requires effort from translators to provide multi-lingual support. If you wish to translate InvenTree to a new language (or improve an existing translation), such contributions would be greatly appreciated!.
|
|
|
|
Native language translation of the InvenTree web application is [community contributed via crowdin](https://crowdin.com/project/inventree).
|
|
|
|
_**Contributions are welcomed and encouraged!**._
|
|
|
|
To contribute to the translation effort, navigate to the [InvenTree crowdin project](https://crowdin.com/project/inventree), create a free account, and start making translations suggestions for your language of choice!
|
|
|
|
### Documentation
|
|
|
|
Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree-docs).
|
|
|
|
If you see any sections of the documentation that require work (i.e. denoted with "TODO") - please consider providing assistance in these sections!
|
|
|
|
### Donate
|
|
|
|
Finally, if you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development.
|
|
|
|
[ Donate <span class='fas fa-smile'></span> ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE¤cy_code=AUD){: .md-button .md-button--primary }
|
|
<img src="{{ config.assets_dir }}/paypal-logo-small-min-300x136.png" border="0" alt="PayPal Logo" style="width: 136px; length:300px; vertical-align:middle; padding-left: 20px">
|
|
|
|
Financial donations directly support the ongoing development of the InvenTree project. If you benefit from the InvenTree project, please consider contributing to maintain vibrant development of this software!
|