berkus
/
topola
mirror of https://codeberg.org/topola/topola.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

contributing,install: some more info and copyediting

This commit is contained in:
Mikolaj Wielgus 2024-08-27 13:17:57 +02:00
parent 3df8aa58d1
commit 5d9753d941
2 changed files with 43 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
CONTRIBUTING.md
View File

@ -13,17 +13,18 @@ requirement to use any legal or real name.
## Chat ## Chat
You are invited to join our [Matrix We invite you to join our [Matrix
chatroom](https://matrix.to/#/%23topola:tchncs.de) or [IRC chatroom](https://matrix.to/#/%23topola:tchncs.de) or [IRC
channel](https://webchat.oftc.net/?channels=#topola) to talk with us channel](https://webchat.oftc.net/?channels=#topola) to talk with us. We
before you contribute. Both chatrooms are bridged, so it does not matter especially encourage you to do so if you are going make any large or
which one you join. complicated changes, as that may require closer coordination. Both
chatrooms are bridged, so it does not matter which one you join.
## Reporting issues ## Reporting issues
If you believe that you have found a defect in Topola or its If you believe that you have found a defect in Topola or its
documentation, please report it on our [issue documentation, or would like to request a feature, please report that on
tracker](https://codeberg.org/topola/topola/issues). our [issue tracker](https://codeberg.org/topola/topola/issues).
Under normal operation, crashes and panics are always considered Under normal operation, crashes and panics are always considered
reportable bugs. reportable bugs.
@ -44,42 +45,52 @@ there are any problems.
To build Topola, follow the build instructions from our [Installation To build Topola, follow the build instructions from our [Installation
guide](INSTALL.md). guide](INSTALL.md).
Topola accepts contributions via pull requests. For a step-by-step guide ### Contribution workflow
Topola accepts contributions as pull requests. For a step-by-step guide
on how to use these, refer to Codeberg's on how to use these, refer to Codeberg's
[documentation](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/). [documentation](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/).
### Working on paid tasks We prefer for the submitted code to be formatted with
[rustfmt](https://github.com/rust-lang/rustfmt). Follow the instructions
in that link to install rustfmt and set up your editor to format code
automatically.
### Working on paid coding tasks
Topola's development is sponsored by [NLnet](https://nlnet.nl/). The Topola's development is sponsored by [NLnet](https://nlnet.nl/). The
tasks which NLnet pays for are tracked in issues labeled coding tasks that NLnet pays for are tracked in issues labeled
[Paid](https://codeberg.org/topola/topola/issues?q=&type=all&state=open&labels=245942&milestone=0&assignee=0&poster=0&fuzzy=false). [Paid](https://codeberg.org/topola/topola/issues?q=&type=all&state=open&labels=245942&milestone=0&assignee=0&poster=0&fuzzy=false).
Anyone, including newcomers, can seek to work on paid tasks and will Each grant is tracked in a separate milestone. Anyone, including
receive the allocated funds upon completion. newcomers, can seek to work on paid tasks and will receive the allocated
funds upon completion.
Before you start working on a paid task, remember to tell us that you Before you start working on a paid task, remember to tell us that you
are claiming it and make sure we agree, so that any collision with are claiming it and make sure we agree, so that any potential collision
someone else's work is prevented. with someone else's work is prevented.
#### Receiving money after task completion #### Receiving money upon task completion
Once you have finished the task, we will contact you via email to add Once you have completed your task, we will contact you via email to add
you as a party to the *memorandum of understanding* (MoU) we have signed you as a party to the *memorandum of understanding* (MoU) we have signed
with NLnet. This will require you to send your domicile address (i.e. with NLnet. This will require you to send your domicile address (i.e.
physical address) to NLnet via a specified email address. NLnet will not physical address, home address) to NLnet via a specified email address.
send your domicile address to anyone else, not even to Topola project NLnet will not send your domicile address to anyone else, not even to
members, so we will not see it. Topola project members, so we will not see it.
You will also have to provide your legal name. You may optionally You will also have to provide your legal name. You may optionally
provide a pseudonym, which will prevent Topola project members from provide a pseudonym, which will make your legal name invisible for
seeing your legal name as well in our communication with NLnet. Topola project members in our communication with NLnet just like your
domicile address.
After all neccessary information is supplied, NLnet will amend the MoU After all necessary information is supplied, NLnet will amend the MoU to
to add you as a party. This may take a few weeks. Afterwards, you will add you as a party. This may take a few weeks. Afterwards, you will
receive a link to submit a *request for payment* (RfP). Once the RfP is receive a link to submit a *request for payment* (RfP). Once the RfP is
submitted and validated by the Topola project, you will receive the submitted, it will be verified by the Topola project, after which you
payment in up to three weeks. You will be able to re-use this link to will receive the payment in up to three weeks. From then on, you will be
request further payments from then on for completing other tasks funded able to re-use the same link to request further payments for completing
from the same grant without having to amend the MoU again. other tasks funded from the same grant without having to amend the MoU
again.
Note that if you receive any money from NLnet, it is your responsibility Note that if you receive any money from NLnet, it is your responsibility
to comply with any local tax laws. to comply with any local tax laws.

13
INSTALL.md
View File

@ -103,7 +103,7 @@ If you chose not to install the GUI application, you can build and run
it without installing by running it without installing by running
``` ```
cargo run --features egui --bin topola-egui` cargo run --features egui --bin topola-egui
``` ```
instead of the above `topola-egui` command. instead of the above `topola-egui` command.
@ -112,17 +112,15 @@ instead of the above `topola-egui` command.
Topola's GUI application can be built to and run in a Web browser using Topola's GUI application can be built to and run in a Web browser using
[Trunk](https://trunkrs.dev/). If you have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) [Trunk](https://trunkrs.dev/). If you have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall)
on your system, you can install Trunk from binary with: on your system, you can install Trunk from binary with
cargo binstall trunk cargo binstall trunk
or you can build it from the source via: Alternatively, you can build Trunk from source by running
cargo install trunk cargo install trunk
To build and open Topola in your browser, run
To build and open Topola in your browser, run:
trunk serve trunk serve
@ -141,7 +139,8 @@ Automated tests are run in `debug` profile.
### Contracts ### Contracts
The feature described in this section works only in `debug` profile. If The feature described in this section works only in `debug` profile. If
you are not interested in debugging, you can skip it altogether. you are not interested in debugging, you can skip this section
altogether.
When trying to locate the source of a bug, it may be helpful to enable When trying to locate the source of a bug, it may be helpful to enable
[contracts](https://en.wikipedia.org/wiki/Design_by_contract) (yes, this [contracts](https://en.wikipedia.org/wiki/Design_by_contract) (yes, this