Giter VIP home page Giter VIP logo

amc-workshop.github.io's Introduction

amc-workshop.github.io

This is the repository for the AMC Github workshop website.

A repository is a collection of files (web pages, images, code, etc) used for a project. Often it is all the non-secret files in a project -- so everything but passwords or secret keys. (This project doesn't have any secrets so everything is here!)

How to contribute

There are a few ways you can contribute. You will need to be logged in to your Github account to do any of these.

Create an issue

See a problem? Think something could be better? Create an issue!

  1. Go to the Issues.
  2. Click "New Issue".
  3. Write your problem or idea.
  4. Click "Submit new issue".

More information about issues:

Submit a pull request

Want to fix or add something?

  1. "Fork" the repository by clicking "Fork" in the upper right hand corner. This will create a copy of the repository in your Github account.
  2. Make changes to your fork. If you are using only Github, edit files or create new files on the Github website and commit your changes to your fork.
  3. Create a pull request on the repository that you forked from (the original repository!).
    1. Click "New pull request".
    2. You want to do a pull request between forks (different repositories), so click "compare across forks". The "base fork" is the repository that you want to add changes to; the "head fork" is the one that's yours and contains the changes. Select your fork from the dropdown.
    3. Look at the changes you've made -- the "diff". The left side is the original. The right side is your version. The diff only shows the parts that have changes. Things you've added are in green, things you've deleted are red.
    4. Click the green "Create pull request" button.
    5. Write a description of your changes and why you made them.
    6. Click "Create pull request".

We will review your pull request and, unless your changes are wantonly destructive, merge it into the project! We may need ask questions or make changes first though. You can reply to questions or comments on the pull request page.

Ideas for pull requests

  • Create a file called "{your name}.md" in the "markdown" directory. For example, I created "libby.md". Then write down your thoughts about this workshop, Allied Media Conference, or life in general! Use Markdown to format your page with headings, links, or lists.
  • Correct grammer, or, spelling mistaeks
  • Write a better explanation of something or make an explanation clearer
  • Add more information or additional links to your favorite resources.
  • Correct an explanation that is just plain wrong!
  • If you know CSS (Cascading Style Sheets), you can edit the style sheets and make the site look different.
  • If you know HTML, you can create or edit HTML files, including the templates in "markdown/templates".
  • If you know the programming language Haskell, you can edit the static site generator.

More information about pull requests

Learning git

We didn't have time to git into learning git itself. (Feel free to make an issue demanding that hideous pun be removed!!)

As great as Github is, you can't do everything with it. You can't create a new repository or merge conflicting pull requests, among other things. If you are interested in working in open source software and/or learning to code, it is well worth your time to master the git command line tool or a git GUI (graphical user interface).

Here are some tutorials:

We encourage you to practice your git skills by working with this repository. Don't worry about breaking things!

How this Github Pages repository works.

This is a Github Pages repository. That means all the files that are stored here are publicly visible on "github.io". You can even download this README.md at http://amc-workshop.github.io/README.md !

But how do the files in "markdown" get turned into HTML? That is not part of Github Pages. But it's not magic, either -- it's code!

If you are curious how it works, you can read more in the README in the site-generator directory. However, that explanation is a little more technical than the rest of this material and assumes you know the basics of how websites work.

CircleCI build status

Resources and essays on contributing to open source/free software

Resources

Essays

amc-workshop.github.io's People

Contributors

emhoracek avatar amc-workshop avatar cassiemoy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.