pybatmesh/HACKING.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2021-07-02 09:30:28 +05:30
# Hacking
Everyone can [hack][] naxalnet. See below for how to hack.
## 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/naxalnet/issues>
2021-07-02 09:30:28 +05:30
While reporting a bug, you need to add the debug messages too. Run
`journalctl -fu naxalnet` on a terminal emulator (this could take some
time). Now on another one, type `sudo systemctl start naxalnet.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.
2021-10-08 22:28:01 +05:30
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 `naxalnet/__init__.py`
2021-07-02 09:30:28 +05:30
## Packaging
Currently this program is only packaged for Arch Linux.
naxalnet needs packages in GNU+Linux+systemd
distributions such as Debian, Fedora, openSUSE,
2021-07-18 20:05:39 +05:30
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