2021-07-02 09:30:28 +05:30
|
|
|
# Hacking
|
|
|
|
|
|
2021-08-13 11:32:42 +05:30
|
|
|
Everyone can [hack][] naxalnet. See below for how to hack.
|
2021-07-07 14:08:05 +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/naxalnet/issues> with a
|
|
|
|
|
relevant label.
|
|
|
|
|
|
2021-08-13 11:32:42 +05:30
|
|
|
## Improving documentation
|
2021-08-02 16:05:24 +05:30
|
|
|
|
2021-08-15 15:02:28 +05:30
|
|
|
The README and HACKING.md needs to be more beginner friendly.
|
|
|
|
|
See section below.
|
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
|
2021-08-15 15:02:28 +05:30
|
|
|
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
|
|
|
|
|
|
2021-08-15 15:02:28 +05:30
|
|
|
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,
|
2021-07-02 09:30:28 +05:30
|
|
|
post to issue #6.
|
2021-07-07 14:08:05 +05:30
|
|
|
|
|
|
|
|
[hack]: https://catb.org/jargon/html/H/hack.html
|
