Skip to content

Commit

Permalink
Adds Pattern Submissions and Adjusts Article Submissions
Browse files Browse the repository at this point in the history
  • Loading branch information
grayghostvisuals committed May 16, 2014
1 parent b794905 commit 287af76
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,23 @@
# Contributing to A11Y Project
Do you enjoy web accessibility and want to help? **Here's how you can help.**

## Pattern Submissions
If you'd like to submit patterns to the A11Y Project make sure to do the following…

1. [Make a CodePen](http://codepen.io/pen) **NOTE** : Please keep code as vanilla as possible. No Sass. No LESS. No HAML etc. You get the point.
2. [Submit your pen to our Issue Tracker](https://github.com/a11yproject/a11yproject.com/issues/new) w/the name of your pattern as the title.
3. Wait for the community to give you feedback and approval. **Note:** Keep the feedback and discussion to the pattern submitted and avoid discussing other patterns. Submit new patterns as separate issues.
4. “Git” down and boogie

![boogie dance](http://bukk.it/gitdown.gif)

## Writing articles
We have a list of articles we'd love to see written. Have an idea for an article? We'd love to know what you want to contribute.

1. Search to make sure someone hasn't snagged the article already.
2. Claim an article by starting a new issue with "Article: your title" as the issue title. The final title can (or probably should) be different.
3. When you check–in, reference that issue number in the commit, e.g., `re: #32`
4. Articles can either be submitted via a pull request or written in plain text at a linkable location on the web. We recommend using GitHub's [gists](https://gist.github.com) (but [OK So Clap](http://oksoclap.com/) is another option if gists aren't your thing). Link us to your [gist](https://gist.github.com) (or your [clap](http://oksoclap.com/)) in the [issue field](https://github.com/a11yproject/a11yproject.com/issues) for your article and we'll be sure to clone and update our site accordingly with your masterpiece. If you are submitting the article via pull request, we have a lovely [sample post file](_posts/example-post.md) to get you started.
4. Articles are written in plain text at a linkable location on the web. We recommend using GitHub's [gists](https://gist.github.com) (but [OK So Clap](http://oksoclap.com/) is another option if gists aren't your thing). Link us to your [gist](https://gist.github.com) (or your [clap](http://oksoclap.com/)) in the [issue field](https://github.com/a11yproject/a11yproject.com/issues) for your article and we'll be sure to clone and update our site accordingly with your masterpiece. When you are ready to submit the article via a pull request, we have a lovely [sample post file](_posts/example-post.md) to get you started.

### Plain-text Workflow for Article Submission
1. Make a [gist](https://gist.github.com) or a [clap](http://oksoclap.com/)
Expand Down
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

A11Y Project
==========

Making *#A11Y* tips and tricks easier to digest and leveraging the community into the cloud. The Accessibility Project is a community–driven effort to make web accessibility easier.

This site is the product of a community of people who want to help to make web accessibility…well, accessible. Our goal is to accomplish this with 3 tennets in mind:
Expand All @@ -13,16 +12,13 @@ This site is the product of a community of people who want to help to make web a

##Contributing
========

- [Contributor Docs](https://github.com/a11yproject/a11yproject.com/blob/gh-pages/CONTRIBUTING.md)
- [Pattern Submissions](https://github.com/a11yproject/a11yproject.com/wiki/Pattern-Submissions)
Everything you need to know about contributing to this project can be found in our [Contributor Docs](https://github.com/a11yproject/a11yproject.com/blob/gh-pages/CONTRIBUTING.md)

##Requirements
========
In order to contribute to the website’s codebase, you’ll need to know a bit about [Jekyll](https://github.com/mojombo/jekyll), [Compass](http://compass-style.org), [Sass](http://sass-lang.com), [Bootstrap](http://getbootstrap.com), [Bash](http://www.gnu.org/software/bash/manual/bashref.html#What-is-Bash_003f) and [Markdown](http://daringfireball.net/projects/markdown/). You'll also need to know how to install *[Ruby Gems](https://rvm.io)* and of course have *[Ruby](http://www.ruby-lang.org/en/downloads/)* installed on your machine.

###Gem Installation

Use the ``bundle`` command to install the necessary gems for the **A11Y Project**. (**Hint**: All the cool kids use [ruby version manager](https://rvm.io) to organize ``gemset`` dependencies):
If you don't have [bundler](http://gembundler.com) installed you'll need to run ``gem install bundler`` before using ``bundle``.

Expand All @@ -31,22 +27,19 @@ If you don't have [bundler](http://gembundler.com) installed you'll need to run
##Under the Hood
========
###Markup

Posts are all written in [Markdown](http://daringfireball.net/projects/markdown).

###Stylesheets
Authored with [Compass](http://compass-style.org) and [Sass](http://sass-lang.com).

###Framework

The site is built on a customized [Compass](http://compass-style.org/) port of [Bootstrap](http://getbootstrap.com). [Jekyll](https://github.com/mojombo/jekyll) is used for templating and posts.

##Local Development
========
The following are tasks which can be run from your shell of choice. Some of us use [iTerm](http://iterm.sourceforge.net/downloads.shtml) for Mac but whatevs.

###Rake Commands

The following ``rake`` tasks are available and are used for testing the site locally, on your own machine (use `rake -T` to list them):

rake build # Build site with Jekyll
Expand Down

0 comments on commit 287af76

Please sign in to comment.