1
0
Fork 0
mirror of synced 2024-04-29 18:23:04 +12:00
Rare/CONTRIBUTING.md

35 lines
1,023 B
Markdown
Raw Permalink Normal View History

2021-02-18 06:54:53 +13:00
# Contributing
## What you can do
### Add translations
2021-09-09 08:48:34 +12:00
To help with translations check [transifex](https://www.transifex.com/rare-1/rare)
2021-02-18 06:54:53 +13:00
### Add Stylesheets
2021-09-09 08:48:34 +12:00
For this you can create a .qss file in rare/resources/stylesheets directory or modify the existing RareStyle.qss file. Here are some
2021-04-13 07:55:08 +12:00
examples:
2021-02-18 06:54:53 +13:00
[Qt Docs](https://doc.qt.io/qt-5/stylesheet-examples.html)
### Add features
Select one Card of the project and implement it, or if you want to add another feature ask me on Discord, or create an
issue on GitHub
2021-04-01 10:11:37 +13:00
2021-04-12 01:56:33 +12:00
## Git crash-course
2021-09-09 08:48:34 +12:00
To contribute fork the repository and clone **your** repo: `git clone https://github.com/YourName/Rare` Then make your changes, add changed files to git with `git add File.xy rare/other_file.py`
and upload it to GitHub with `git commit -m "message"` and `git push`. Some IDEs like PyCharm can do this automatically.
If you uploaded your changes, create a pull request
2022-08-14 03:53:00 +12:00
# Code Style Guidelines
## Signals and threads
## Function naming
## UI Classes
### Widget and Layout naming