- Creating an account
- It can be helpful to use a recognizable username.
- May want to separate your personal account from your work account.
- Associate your work email with account to get a free micro plan:
- Docs
- Profile
- Repositories, Followers, Starred, Following
- Settings
- Profile
- It can be helpful to set your avatar. I recommend a portrait.
- Emails
- Associate your work email for free micro plan.
- Security
- Password security and two-factor authentication.
- Notification center
- Email vs. web vs. RSS
- watching, automatically watching repos you have push access to
- per-organization email routing
- Profile
- News Feed
- Watching repos and followed users
- Issues
- Labels, Milestones
- Pull Requests
- Various links, dest repo, source repo, pull request.
- Status (icon and link)
- Creating a repo
- Forking
- Search
- Keyboard Shortcuts
- Setting up SSH key(s)
- "Password-less" Git access
- GitHub Help: Generating SSH Keys
ssh-add -K
or Setup Keychain to Manage SSH Keys
- Writing on GitHub
- Personal Repos vs. Organization Repos
- Organization RSS Feed
- Where should we fork this repository?
- How do I install 'hub'?
- create, fork, pull-request
- How do I fork a repository?
- How do I make a pull request?
- How do I review a pull request?
- How do I know my pull request will be (or has been) reviewed?
- How do I
git checkout
a pull request? - Merge Pull Request
- Introduction to CI
- Travis CI
- Travis CI Documentation
- Examples: Perl, C++, Ruby, Python
- apipe-ci
- Use Travis CI unless you need access to internal resources (not ideal).
- Get APIPE to set it up.
- Examples
genome/genome
secret phrases:- Can one of the admins verify this patch?
- CI, add author to whitelist. (
.*CI\W+add\W+author\W+to\W+whitelist.*
) - CI, test this. (
.*CI\W+test\W+this.*
) - CI, test this once. (
.*CI\W+test\W+this\W+once.*
) - CI, skip this. (
.*CI\W+skip\W+this.*
)
- Details link.
- Lots of other services. Use what you want. Be aware of trade-offs.
- Travis CI
- Questions/Policies
- To +1/+2 or not.
- To require/encourage multiple +1/+2 or not.
- How long to wait before merge.
- How aggressive to be with closing pull requests.
- Should you wait for new +1/+2 if you push new commits?
- Comments
- Make sure you leave a comment on the pull request if you push new commits. Otherwise no notification is sent.
- Comment threading.
- Mark moved Ptero repos from his username to
genome
and it transferred issues and pull requests successfully.
Looks good! A couple of small suggestions:
As part of creating an account, I would strongly advise (require?) that they set up 2 factor authentication of some sort.
As part of notifications, I might talk about the notification center vs. email and how to pick which notifications go where.