amr/discorss
amr/discorss
1
0
Fork 0
Code Issues 1 Pull requests Projects 1 Releases 1 Packages Wiki Activity Actions

Updated README with contribution guidelines.

Browse source
This commit is contained in:
A.M. Rowsell 2025-01-31 23:35:31 -05:00
parent da7ec6ddda
commit 2439765117
Signed by: amr
GPG key ID: 0B6E2D8375CF79A9
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -75,3 +75,9 @@ WantedBy=timers.target
```
To change how often this fires, edit the OnCalendar parameter. The config above has it firing every 15 minutes at half past the minute. Look at the systemd timer man pages for help if you want to tweak it.
## Contributing
Want to fix something or make a suggestion? Feel free! If you want to send a pull request, you *must* run the Python `black` formatter on the source code before committing. I have this set up in my editor to automatically run every time I save the file, but you could have it run as part of a git hook or something. For non-format stuff, please just follow the code style as best you can. For Python code, I separate multi-word variable names with underscores. So it should be `feed_time`, not `feedTime` or `FeedTime` or `feed-time`. Don't ask me why, but I use camelCase for other languages... but in Python I've switched to underscores.
If you know how and are able to, *please* sign your commits with the `-S` option to `git commit`. This shows that you are the author, especially if others have signed your keys.