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

docs(contributing): copyedit and clarify

This commit is contained in:
Mikolaj Wielgus 2024-12-10 03:17:35 +01:00
parent 0184a6537e
commit 1c30cd253a
1 changed files with 51 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
CONTRIBUTING.md
View File

@ -2,95 +2,90 @@
*Anyone* can contribute to Topola, including you. *Anyone* can contribute to Topola, including you.
Contributions can be of any kind: documentation, organization, Contributions can be of any kind: documentation, organization, tutorials,
tutorials, blog posts, bug reports, issues, feature requests, feature blog posts, bug reports, issues, feature requests, feature implementations,
implementations, pull requests, helping to manage issues, etc.. Many of pull requests, helping to manage issues, and so on. Many of these tasks do not
these tasks do not require specialized programming knowledge, or any require specialized programming knowledge, or any programming at all.
programming at all.
You may contribute to Topola under any identity you want. There is no You may contribute to Topola under any identity you want. There is no
requirement to use any legal or real name. requirement to use any legal or real name.
## Chat ## Chat
We invite you to join our [Matrix We invite you to join our
chatroom](https://matrix.to/#/%23topola:tchncs.de) or [IRC [Matrix chatroom](https://matrix.to/#/%23topola:tchncs.de)
channel](https://webchat.oftc.net/?channels=#topola) to talk with us. We or [IRC channel](https://webchat.oftc.net/?channels=#topola) to talk with us. We
especially encourage you to do so if you are going make any large or especially encourage you to do so if you are going make any large or complicated
complicated changes, as that may require closer coordination. Both changes, as that often requires closer coordination. Both chatrooms are bridged,
chatrooms are bridged, so it does not matter which one you join. 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,
documentation, or would like to request a feature, please report that on or would like to request a feature, please report that on our
our [issue tracker](https://codeberg.org/topola/topola/issues). [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
reportable bugs. bugs.
## Translation ## Translation
If you know any language other than English, you can help by translating If you know any language other than English, you can help by translating Topola
Topola on [Weblate](https://translate.codeberg.org/engage/topola/). on [Weblate](https://translate.codeberg.org/engage/topola/).
![](https://translate.codeberg.org/widget/topola/topola/multi-auto.svg) ![](https://translate.codeberg.org/widget/topola/topola/multi-auto.svg)
## Writing code ## Writing code
We welcome code from anyone regardless of skill or experience level. We welcome code from anyone regardless of skill or experience level. We are
We are friendly to newcomers. We will help you with your contribution if friendly to newcomers. We will help you with your contribution if there are
there are any problems. any problems.
To build Topola, follow the build instructions from our [Installation To build Topola, follow the build instructions from our
guide](INSTALL.md). [Installation guide](INSTALL.md).
### Contribution workflow ### Contribution workflow
Topola accepts contributions as pull requests. For a step-by-step guide Topola accepts contributions as pull requests. For a step-by-step guide on how
on how to use these, refer to Codeberg's 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/).
We prefer for the submitted code to be formatted with We prefer for the submitted code to be formatted with
[rustfmt](https://github.com/rust-lang/rustfmt). Follow the instructions [rustfmt](https://github.com/rust-lang/rustfmt). Follow the instructions in that
in that link to install rustfmt and set up your editor to format code link to install rustfmt and set up your editor to format code automatically.
automatically.
### Working on paid coding tasks ### 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/). If there are
coding tasks that NLnet pays for are tracked in issues labeled any paid tasks available, they 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).
Each grant is tracked in a separate milestone. Anyone, including Each grant is tracked in a separate milestone. Anyone, including newcomers, can
newcomers, can seek to work on paid tasks and will receive the allocated seek to work on paid tasks and will receive the allocated funds upon completion.
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
are claiming it and make sure we agree, so that any potential collision claiming it and make sure we agree, so that any potential collision with someone
with someone else's work is prevented. else's work is prevented.
#### Receiving money upon task completion #### Receiving money upon task completion
Once you have completed your 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
you as a party to the *memorandum of understanding* (MoU) we have signed party to the *memorandum of understanding* (MoU) we have signed with NLnet. This
with NLnet. This will require you to send your domicile address (i.e. will require you to send your domicile address (your permanent home address) to
physical address, home address) to NLnet via a specified email address. NLnet via a specified email address. NLnet will not send your domicile address
NLnet will not send your domicile address to anyone else, not even to to anyone else, not even to Topola project 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
provide a pseudonym, which will make your legal name invisible for pseudonym, which will make your legal name invisible for all Topola project
Topola project members in our communication with NLnet just like your members just like your domicile address.
domicile address.
After all necessary information is supplied, NLnet will amend the MoU to After all necessary information is supplied, NLnet will amend the MoU to add
add you as a party. This may take a few weeks. Afterwards, you will you as a party. This may take a few weeks. Afterwards, you will receive a link
receive a link to submit a *request for payment* (RfP). Once the RfP is to submit a *request for payment* (RfP). Once the RfP is submitted, it will
submitted, it will be verified by the Topola project, after which you be verified by the Topola project, after which you will receive the payment in
will receive the payment in up to three weeks. From then on, you will be up to three weeks. From then on, you will be able to re-use the same link to
able to re-use the same link to request further payments for completing request further payments for completing other tasks funded from the same grant
other tasks funded from the same grant without having to amend the MoU without having to amend the MoU again.
again.
Note that if you receive any money from NLnet, it is your responsibility Note that it is your responsibility to comply with any local tax laws for any
to comply with any local tax laws. money you receive from NLnet. You may find some more information in NLnet's
[FAQ](https://nlnet.nl/entrust/faq/).