Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs wip dachary contributor privilege #2972

Merged
merged 5 commits into from
Feb 5, 2018
Merged

Docs wip dachary contributor privilege #2972

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da83c3a
docs: establish a light weight privilege elevation process
Feb 5, 2018
7b7aa37
docs: cross linking privilege for i18n and development
Feb 5, 2018
ede36a3
docs: increase the privilege expiration delay to six months
Feb 5, 2018
b71b615
Reformats procedure for maintainer status grants
Feb 5, 2018
35a50e5
Clarifies distinction between maintainer workflows
Feb 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions docs/development/contributor_guidelines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,35 @@ should be removed. If you are unfamiliar with how to squash commits with rebase,
check out this
`blog post <http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html>`__.

.. _contributor-permissions:

Privileges
----------

.. note:: the translation workflow is different from the code and
documentation development workflow, see the associated
:ref:`privilege escalation <i18n-administrator-permissions>`
documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section (and the corresponding Note over in the i18n docs) could be worded more clearly—I'll add some suggestions.


Dedicated contributors to SecureDrop will be granted extra privileges
such as the right to push new branches or to merge pull
requests. There is no formal process at the moment but the general
idea is that any contributor with the right technical and social
skills is entitled to ask. The people who have the power to grant such
privileges are committed to do so in a transparent way to avoid any
disputes.
such as the right to push new branches or to merge pull requests. Any
contributor with the right technical and social skills is entitled to
ask. The people who have the power to grant such privileges are
committed to do so in a transparent way as follows:

* Step 1: the contributor posts a message `in the forum
<https://forum.securedrop.club/>`__ asking for privileges (review or
merge, etc.).
* Step 2: after at least a week someone with permissions to grant such
privilege reviews the thread and either:
* grants the privilege if there are no objections from current
maintainers and adds a message to the thread
* explains what is expected from the contributor before they can
be granted the privilege
* Step 3: the thread is closed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some formatting nits about the layout of steps 1-3; again, will add specific suggestions for inclusion shortly. The content is definitely solid, so my changes will be cosmetic.


The privileges of a developer who has not been active for six months or
more are revoked. They can apply again at any time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍, particularly with @redshiftzero's one year -> six months revision. It's worth pointing out that the definition of "active" will vary somewhat based on the specific privileges, e.g. those with "review" privilege must review PRs in order to remain active—but I won't clutter up the docs with such minutiae.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is tempting to go into details indeed :-) I suspect we'll actually scrub privileges over longer periods when someone feels like it and the method will vary over time.


Other Tips
----------
Expand Down
12 changes: 9 additions & 3 deletions docs/development/i18n.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,9 +297,16 @@ We do not want to publish the translator emails so we strip them:
git log --pretty='%aN' $previous_version..lab/i18n -- \
securedrop/translations install_files/ansible-base/roles/tails-config/templates | sort -u

.. _i18n-administrator-permissions:

Translations administrators
---------------------------

.. note:: the translation workflow is different from the code and
documentation development workflow, see the associated
:ref:`privilege escalation <contributor-permissions>`
documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above: any edits to the Note on the developer maintainer status should be matched by changes here.


A translation administrator is a person who is actively performing
administrative duties. They have special permissions on the
repositories and the translation platform. When someone is willing to
Expand All @@ -313,9 +320,8 @@ among the current administrators.
All administrators are listed in the `forum introduction page
<https://forum.securedrop.club/t/about-the-translations-category/16/1>`_

An administrator who has not be active for two months or more is
removed from the list and their permissions revoked. They can apply
again at anytime.
The privileges of an administrator who has not been active for six months
or more are revoked. They can apply again at any time.

The community of SecureDrop translators works very closely with the
SecureDrop developers and some of them participate in both
Expand Down