Hi,

This is the proposed workflow for working on GitHub for our Apache Flex
Whiteboard repos:

*ApacheFlex@GitHub Initial setup:*

1.  Create an organization account (free for open source) for Apache Flex
on www.github.com.  The public url will be https://github.com/apacheflex.
2.  Share the organization account details with the Flex PMC at
priv...@flex.apache.org
3.  Any Apache Flex PMC member should be able to edit and maintain the
organization account on github.
4.  Alternatively, a PMC member can add their private github account to the
organization and get admin access.

*Committer Initial setup:*

1.  An Apache Flex Committer creates a github account (or uses their
existing account)
2.  The committer posts on dev@flex.apache.org requesting to be added to
the github.com/apacheflex organization with the following details:
3.  A PMC member logs into github.com and adds the committer's github
account to the github.com/apacheflex organization
4.  The committer creates their public whiteboard project at:
github.com/apacheflex/whiteboard_<committerAlias>
5.  If it is a repo cloned from our GitHub mirror, we could allow a repo
like: github.com/apacheflex/whiteboard_<committerAlias>_flex-sdk (for
example)
6.  The committer adds their <committerAlias>@apache.org email address as
their default email in their github account.

*Whiteboard repo setup:*
*
*
1.  The whiteboard repo at: github.com/apacheflex/whiteboard_<committerAlias>
should have the file: CONTRIBUTING.md at the top level of the repo
2.  This file is based on template which contains the guidelines about
contributing to Apache.
3.  The committer is free to chose what goes in this repo.  For example,
they can be fork from our GitHub mirror at
https://github.com/apache/flex-sdk or they could copy paste some sample
code into the repo.
4.  The whiteboard repo at: github.com/apacheflex/whiteboard_<committerAlias>
 must have a GitHub 'Service Hook' with these parameters:

ServiceHook Name: Email
Address: comm...@flex.apache.org
Secret: <Leave blank>
Send from Author: <checked>
Active: <checked>

5.  This will ensure that whenever a commit is made, a notification is sent
to comm...@flex.apache.org just like how Apache's Git servers do.

*Committer <-> Contributor workflow:*
1.  Any public github user can fork an Apache Flex committer's whiteboard
from github.com/apacheflex/whiteboard_<committerAlias> to github.com/
<public_use>/<public_use_repo_name>
2.  The contributor can work on their repo and send a pull request back to
the committer
3.  In the 'Send Pull Request' screen, GitHub automatically shows the link
to the 'Contributing guidelines' link to the CONTRIBUTING.md file on the
whiteboard repo.
4.  The contributor implicitly agrees to Apache's contributing guidelines
and sends the pull request
5.  Once the committer receives the pull request, he/she is free to accept
or reject
6.  Once the pull request is merged, a notification is sent to
comm...@flex.apache.org

Please respond with comments and suggestions.  Ideally, a couple of
committers can volunteer to run these steps and see if there are any holes
in this approach.

Thanks,
Om

Reply via email to