1 of 32

Moar things you can do with GitHub

​

​

​

​

Friendly Github Workshop

April 2017 - Cambridge, UK

2 of 32

Lead your own open source project

These special files are really useful for new contributors:

  • README
  • CONTRIBUTING
  • CODE OF CONDUCT
  • LICENSE

3 of 32

README

4 of 32

Basics of README.md

5 of 32

in your root directory, all caps, in markdown (.md)

6 of 32

The Almighty README:

It is a file (.md) with text in it that describes:

  • what you're doing, for who, and why
  • what makes your project special and exciting
  • how to get started
  • where to find key resources

7 of 32

CONTRIBUTING

8 of 32

Basics of CONTRIBUTING.md

9 of 32

in your root directory, all caps, in markdown (.md)

10 of 32

  • location
  • cheer
  • introduction
  • how-to
  • style

HOW?

11 of 32

  • location
  • cheer
  • introduction
  • how-to
  • style

HOW?

12 of 32

  • location
  • cheer
  • introduction
  • how-to
  • style

HOW?

13 of 32

  • location
  • cheer
  • introduction
  • how-to
  • style

HOW?

14 of 32

  • location
  • cheer
  • introduction
  • how-to
  • style

HOW?

15 of 32

Link appears when you contribute

16 of 32

CODE OF CONDUCT

https://www.flickr.com/photos/mozfest/22455631157/in/album-72157658649418943/

17 of 32

code of conduct (n).

a set of rules outlining the social norms & rules & responsibilities of an individual project, party or organization.

18 of 32

Basics of CODEOFCONDUCT.md

19 of 32

in your root directory, all caps, in markdown (.md)

20 of 32

getting started ...

  • Describe core words - These could be values, ideals, or characteristics of people you want to be associated to your community.
  • Behaviors to encourage? Discourage?
  • Process of bringing issues to the table.
  • Consequences of breaking the code.
  • Understanding your role.

21 of 32

LICENSE

22 of 32

Basics of LICENSE.md

23 of 32

in your root directory, all caps, in markdown (.md)

24 of 32

Finding the right license for you:

  • Sharing your project online isn’t everything
  • it’s also important to tell people how they can use that project.
  • Choosing an open source license can be confusing.
  • These folks created ChooseALicense.com to help you make that decision.

25 of 32

Don’t want to license?

  • You're under no obligation to choose a license.
  • It's your right not to include one with your code or project,
  • Generally speaking, the absence of a license means that the default copyright laws apply.
  • This means that you retain all rights to your source code and that nobody else may reproduce, distribute, or create derivative works from your work. This might not be what you intend.

26 of 32

Host a website

The special branch called gh-pages hosts a static website for you!

​

You’re also hosting the webpage through your fork!

27 of 32

Under settings you can setup the GitHub pages

28 of 32

Website for this course is hosted via gh-pages!

29 of 32

In fact - you’re hosting a site now too!

The special branch called gh-pages hosts a static website for you!

​

You’re also hosting the webpage through your fork!

30 of 32

Private Repositories

https://education.github.com/ to request unlimited private repositories

31 of 32

The World is your Oyster

https://octodex.github.com

32 of 32

Thank you!

​

​

  • Kirstie Whitaker
  • Gord Brown
  • Office for Scholarly Communication
  • Joey Lee
  • Stephanie Wright
  • Mozilla Science Lab
  • YOU!

​

Questions on the etherpad or as issues to the workshop repository!

​

Friendly Github Workshop

April 2017 - Cambridge, UK