pybatmesh/HACKING.md
Pranav Jerry 0a85c465ee
added features section in README.md
And added some more info on adding bug reports.
See issue #20.
2021-10-15 16:05:06 +05:30

1.2 KiB

Hacking

Everyone can hack naxalnet. See below for how to hack.

Reporting issues and suggesting ideas

To report a bug or suggest an idea, create a new issue at https://git.disroot.org/pranav/naxalnet/issues

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

The README and HACKING.md needs to be more beginner friendly. See #20.

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

Packaging

Currently this program is only packaged for Arch Linux. naxalnet 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.