-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Add GitHub organization documentation #26
Changes from all commits
093cc00
73d75a6
dc0a226
28517a2
d4165a3
92a153b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,103 @@ | ||
################### | ||
GitHub organization | ||
=================== | ||
################### | ||
|
||
This page explains how the `RITlug GitHub organization`_ is organized and how | ||
it is intended to be used. | ||
to manage it. | ||
|
||
.. _`RITlug GitHub organization`: https://github.com/RITlug | ||
|
||
…more to come soon. | ||
******* | ||
Purpose | ||
******* | ||
|
||
The GitHub organization is a central place to manage club projects, membership, | ||
and infrastructure. Most data is static and doesn't change often. Setting up | ||
club projects or adding a new member is when you usually need to interact with | ||
the GitHub organization. | ||
|
||
|
||
************ | ||
Repositories | ||
************ | ||
|
||
There are no restrictions on repositories allowed. Repository creation | ||
permission is granted only to eboard members as a precaution. This approach was | ||
decided to ensure that the current eboard has a chance to review a project | ||
before officially endorsing it underneath our GitHub organization. | ||
|
||
Generally, repository creation should be encouraged rather than discouraged. | ||
|
||
|
||
****************** | ||
Adding new members | ||
****************** | ||
|
||
There is no criteria for adding new members to the RITlug GitHub organization. | ||
There are no requirements to add new members to the RITlug GitHub organization | ||
other than being an active community member. In the future, if a membership | ||
criteria is developed, this section should be updated. | ||
|
||
Active community members of RITlug should be added to the GitHub organization. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. With the new commit, this becomes redundant. Maybe a horizontal line if you don't want to keep it like this? I'm going to dismiss my blocking review, but I'm not going to approve the PR since this feels awkward to me. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jflory7 ^ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it's okay. It's important we keep good habits of keeping things well-maintained over time – commit early, commit often. If it's not perfect now, we can always revisit. I think a membership discussion is more important to clarifying this, but it won't be solved relatively soon to block this PR. |
||
Adding a new person to the GitHub organization validates their contributions and | ||
activity in the club and helps others be included with projects. Past eboards | ||
intentionally chose a loose definition of membership in GitHub for this reason. | ||
|
||
These steps should be followed to add a new member: | ||
|
||
#. Add them to organization via GitHub | ||
#. File new issue in `RITlug/tasks`_ to welcome them | ||
#. Add them to an appropriate GitHub Team (detailed below) | ||
|
||
.. figure:: /_static/img/github-org-add-member.png | ||
:alt: Add a new member to the GitHub organization from the People page | ||
|
||
Add a new member to the GitHub organization from the People page | ||
|
||
Welcome message | ||
=============== | ||
|
||
To welcome a new member to GitHub and to notify them of why they were added, | ||
file a new issue in `RITlug/tasks`_ to explain why they were added and how to | ||
set their membership status to public. Past examples can be used as references | ||
([#f1]_ [#f2]_ [#f3]_). | ||
|
||
Telling the person how to set their membership as public is important. This | ||
instruction should always be included in the welcome message. | ||
|
||
.. [#f1] https://github.com/RITlug/history/issues/12 | ||
.. [#f2] https://github.com/RITlug/history/issues/13 | ||
.. [#f3] https://github.com/RITlug/history/issues/18 | ||
|
||
|
||
************ | ||
GitHub Teams | ||
************ | ||
|
||
GitHub Teams are a tool to organize members inside of a GitHub organization. | ||
This also allows for permission matrices for different repositories and | ||
projects. | ||
|
||
.. figure:: /_static/img/github-org-teams.png | ||
:alt: GitHub Teams in our organization | ||
|
||
GitHub Teams in our organization | ||
|
||
There are four teams: | ||
|
||
#. **Eboard**: Club leadership (grants admin access to all repositories) | ||
|
||
#. **Friends of RITlug**: Active participants with the club from outside RIT or | ||
other friends of the club (does not include permissions) | ||
|
||
#. **Members**: RIT students, faculty, and staff participating in RITlug (does | ||
not include permissions) | ||
|
||
#. **TigerOS Team**: `TigerOS`_ project team (grants write access to TigerOS | ||
repositories) | ||
|
||
Anyone added to the GitHub organization should belong to at least one team. | ||
|
||
|
||
.. _`RITlug GitHub organization`: https://github.com/RITlug | ||
.. _`RITlug/tasks`: https://github.com/RITlug/tasks | ||
.. _`TigerOS`: http://tigeros.ritlug.com/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really? This also contradicts the "active community members" on L39.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ct-martin When I said we don't have criteria for adding new members, we do not have a firm set of criteria, e.g. attend X number of meetings, participate over X amount of time, etc.
What change are you suggesting?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jflory7 At the very least, not saying there are no criteria. If I remember correctly, the "technical" definition for Club Office is attending three meetings/semester (correct me if I'm wrong). While this may seem like an unlikely scenario, what we don't want to have happen is someone who none of us have ever interacted with coming and waving this in our face.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ct-martin I think this fits into a larger discussion for our club membership. I am not aware of any existing guideline / requirement even to club office for our membership. As it is now, there really is not any criteria. I only add people when I remember.
We can move a membership discussion to RITlug/tasks, but I don't think this should block this PR. We can go back and make a change after we consider general membership criteria.
Personally, I would like club members to ask to be included in the GitHub organization. In your scenario you gave, we can use our own discretion for how to answer. If someone who we never see asks to be included in our GitHub organization, I would not consider them an active community member and would use that as my reply.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jflory7 In that case, I would put being an active community member as the criteria, or just drop the line in favor of L39, "Active community members of RITlug should be added to the GitHub organization."
I'm going to maintain my blocking review and cite your response to my scenario as additional reasoning for why.