pybatmesh/HACKING.md

34 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-07-02 09:30:28 +05:30
# Hacking
Everyone can [hack][] pybatmesh. See below for how to hack.
2021-12-10 20:16:34 +05:30
## Reporting issues and suggesting ideas
2021-07-02 09:30:28 +05:30
To report a bug or suggest an idea, create a new issue at
<https://git.disroot.org/pranav/pybatmesh/issues>
2021-07-02 09:30:28 +05:30
While reporting a bug, you can add the debug messages to provide more
data. Run `journalctl -fu pybatmesh` on a terminal emulator (this could
take some time on some machines). Now on another one, type `sudo systemctl start pybatmesh.service` or whatever caused the error. Now copy the error
messages and paste it in the issue body along with the description.
## Improving documentation
2021-08-02 16:05:24 +05:30
The README and HACKING.md needs to be more beginner friendly. See #20.
2021-08-02 16:05:24 +05:30
2021-07-02 09:30:28 +05:30
## Contribute code
To push to this repo, you need your username to be in the contributors
list. Add your username to issue #8 to add you as a contributor. Before
each commit, update the CHANGELOG.md and `__version__` in
`pybatmesh/__init__.py`
2021-07-02 09:30:28 +05:30
## Packaging
Currently this program is only packaged for Arch Linux. pybatmesh needs
packages in GNU+Linux+systemd distributions such as Debian, Fedora,
openSUSE, and nixos. If you know/like to package it in your distro, post a
message to issue #6.
[hack]: https://catb.org/jargon/html/H/hack.html