mirror of
https://github.com/akuker/RASCSI.git
synced 2025-01-26 00:30:41 +00:00
Add concrete instructions on how to contribute code. (#797)
* Add concrete instructions on how to contribute code. * Document the Python interpreter support policy * Clarify contribution guidelines
This commit is contained in:
parent
8846871e47
commit
9302955416
@ -13,10 +13,14 @@ RaSCSI Reloaded is using the <a href="https://datasift.github.io/gitflow/Introdu
|
||||
|
||||
Typically, releases will only be planned every few months.
|
||||
|
||||
When you are ready to contribute code to RaSCSI Reloaded, follow the <a href="https://docs.github.com/en/get-started/quickstart/contributing-to-projects">GitHub Forking and Pull Request workflow</a> to create your own fork where you can make changes, and then contribute it back to the project. Please remember to always make Pull Requests against the *develop* branch.
|
||||
|
||||
If you want to add a new translation, or improve upon an existing one, please follow the <a href="https://github.com/akuker/RASCSI/blob/develop/python/web/README.md#localizing-the-web-interface">instructions in the Web Interface README</a>. Once the translation is complete, please use the same workflow as above to contribute it to the project.
|
||||
|
||||
<a href="https://www.tindie.com/stores/landogriffin/?ref=offsite_badges&utm_source=sellers_akuker&utm_medium=badges&utm_campaign=badge_large"><img src="https://d2ss6ovg47m0r5.cloudfront.net/badges/tindie-larges.png" alt="I sell on Tindie" width="200" height="104"></a>
|
||||
|
||||
# Github Sponsors
|
||||
Thank you to all of the Github sponsors who support the development community!
|
||||
# GitHub Sponsors
|
||||
Thank you to all of the GitHub sponsors who support the development community!
|
||||
|
||||
Special thank you to the Gold level sponsors!
|
||||
- <a href="https://github.com/mikelord68">@mikelord68</a>
|
||||
|
@ -1,12 +1,21 @@
|
||||
# RaSCSI Python Apps
|
||||
# RaSCSI Reloaded Python Apps
|
||||
|
||||
This directory contains Python-based clients for RaSCSI as well as common
|
||||
This directory contains Python-based clients for RaSCSI Reloaded as well as common
|
||||
packages that are shared among the clients.
|
||||
|
||||
The following paragraphs in this README contain instructions that are shared
|
||||
among all Python apps.
|
||||
|
||||
### Static analysis with pylint
|
||||
## Supported Python interpreter
|
||||
|
||||
The policy in this project is to support the Python 3 interpreter that comes
|
||||
standard with the current stable, as well as previous stable release of Debian.
|
||||
|
||||
At the time of writing they are:
|
||||
- Python 3.9.2 in [Debian Bullseye](https://packages.debian.org/bullseye/python3)
|
||||
- Python 3.7.3 in [Debian Buster](https://packages.debian.org/buster/python3)
|
||||
|
||||
## Static analysis with pylint
|
||||
|
||||
It is recommended to run pylint against new code to protect against bugs
|
||||
and keep the code readable and maintainable.
|
||||
@ -29,4 +38,4 @@ pylint web/src/web.py
|
||||
pylint common/src
|
||||
pylint web/src
|
||||
pylint oled/src
|
||||
```
|
||||
```
|
||||
|
@ -40,7 +40,7 @@ $ git push pi master
|
||||
|
||||
## Localizing the Web Interface
|
||||
|
||||
We use the Flask-Babel library and Flask/Jinja2 extension for i18n.
|
||||
We use the Flask-Babel library and Flask/Jinja2 extension for internationalization (i18n).
|
||||
|
||||
It uses the 'pybabel' command line tool for extracting and compiling localizations. The Web Interface start script will automatically compile localizations upon launch.
|
||||
|
||||
@ -114,6 +114,10 @@ msgstr ""
|
||||
"drivrutiner och inställningar</a>."
|
||||
```
|
||||
|
||||
### Contributing to the project
|
||||
|
||||
New or updated localizations are treated just like any other code change. See the [project README](https://github.com/akuker/RASCSI/tree/rdmark-readme-contributions#how-do-i-contribute) for further information.
|
||||
|
||||
### (Optional) See translation stats for a localization
|
||||
Install the gettext package and use msgfmt to see the translation progress.
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user