You are here: start » en » Internal Documentation » Working with projects » Contributing

Contributing

Contributing here means going beyond the role reader and adding changes to the source or the project documentation. This page explains the roles and leads to the steps.

Getting started

Common tasks

The ladder of roles

<html>

<div style="display:grid;grid-template-columns:repeat(4,minmax(120px,1fr));min-width:520px">
  <div style="border-right:1px solid var(--wk-border-light, #e3e6ec);padding:10px 12px">
    <div style="font:600 12px/1.4 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-ink, #3b4252)">1 Reader</div>
    <div style="font:11px/1.5 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-text, #5b6472)">view, obtain</div>
  </div>
  <div style="border-right:1px solid var(--wk-border-light, #e3e6ec);padding:10px 12px">
    <div style="font:600 12px/1.4 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-ink, #3b4252)">2 Contributor</div>
    <div style="font:11px/1.5 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-text, #5b6472)">create, edit</div>
  </div>
  <div style="border-right:1px solid var(--wk-border-light, #e3e6ec);padding:10px 12px">
    <div style="font:600 12px/1.4 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-ink, #3b4252)">3 Maintainer</div>
    <div style="font:11px/1.5 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-text, #5b6472)">membership, settings</div>
  </div>
  <div style="padding:10px 12px">
    <div style="font:600 12px/1.4 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-ink, #3b4252)">4 Administrator</div>
    <div style="font:11px/1.5 var(--wk-font-body, system-ui, sans-serif);color:var(--wk-text, #5b6472)">wiki-wide, not per project</div>
  </div>
</div>

</html>

Level What it may do
1 Reader view the project and released repositories, obtain archives
2 Contributor additionally create and edit content; depending on the mount, push as well
3 Maintainer additionally decide on membership and project settings
4 Administrator wiki-wide rights; explicitly not a per-project level

Key features

  • Your own role is on every project card and in the header of every repository screen.
  • Contributor access can be asked for as a structured request; it carries project, wanted and current role and the group to enter automatically.
  • The source is reachable through a Git endpoint; clone, fetch and push work.
  • Single files can be edited directly in the repository screen where the permission suffices.

The underlying idea

The role is evaluated at the project's root point and applies to the whole project. It is granted by membership in a project group whose name is formed from a fixed prefix and the project key; the applicable group names are on the page that explains a closed area, so that a request can name what it asks for. Separately from that, a repository's mount decides who may view, obtain, propose or write it — a contributor role in the project therefore does not automatically mean write access on each of its repositories. A request never itself grants a permission; it creates a record.

Administration

Whoever is a maintainer of a project manages its members themselves: the section Mitwirken on the project page leads to Mitglieder, where reader and contributor roles are granted, changed and withdrawn. Wiki administration rights are not needed for that — the project role decides.

What is not granted there is the role maintainer itself; the wiki administration appoints those. What else is open is at State of the contribution rules.

Troubleshooting

None. Projects or repositories expected but missing are covered under Remarks in Find projects and Find repositories.

For developers

en/wiki/projects/contributing.txt · Last modified: by 0.0.0.0