Skip to content
Permalink
Browse files

fix: update markdown formatting to comply with our own markdown guide…

…lines

These changes are all formatting related. They shouldn't affect the content at all.
  • Loading branch information...
bryanbraun authored and catheraaine committed Oct 29, 2018
1 parent 50b66b4 commit 844dccb546cbaee7337d0fc444c8abb5e5bc3c8b
@@ -1,18 +1,15 @@
Assemble
========
# Assemble

![Assemble Logo](https://avatars2.githubusercontent.com/u/2645080?s=140)

The static site generator we use to build templates.

Docs
-----
## Docs

* [Assemble](http://assemble.io/docs/)
* [Assemble Helpers](http://assemble.io/helpers/)

Causes for common errors:
-----
## Causes for common errors:

* If there is a conflict between values in our `YAML` data files and Handlebars helpers they often throw strange, unhelpful error messages. This can be fixed by scoping references in `hbs` files to the current object, for example: `this.icon` will avoid conflicts with the `icon` helper.

@@ -23,4 +20,4 @@ Known helpers that we often conflict with:
* `copy`
* `content`

* Data lists cannot be given the same name as the filename. The grunt task will not throw an error, but the entire partial will mysteriously fail.
* Data lists cannot be given the same name as the filename. The grunt task will not throw an error, but the entire partial will mysteriously fail.
@@ -1,5 +1,4 @@
Code Style
==========
# Code Style

* **[All Code](all_code)**
* **[Ruby](ruby)**
@@ -1,5 +1,4 @@
All Code
========
# All Code

![Code Quality][xkcd]

@@ -1,22 +1,15 @@
Code Review Process
=====
# Code Review Process

Code reviews should be happening at different stages in our development process.


In the Flow
-----
## In the Flow

Please utilize other Sparkboxers while you are working. Bounce ideas off of each other, get feedback, ask questions, debate different opinions. It's this level of care and detail about how the web should be built that has helped make us who we are. Debates on semantic class names, proper HTML elements, the right way to test something, etc. are always welcome and encouraged. Just keep it positive and friendly, and we will help to enrich and teach each other.


Pull Requests
-----
## Pull Requests

PRs are the perfect place for code reviews to happen. Please use these as a place to ask questions about how/why things are done, make suggestions, give praise for an awesome solution to a problem, or use that new animated GIF that you've been dying to show off. Conversations here will only lead to better products in the end.


The Lone Wolf
-----
## The Lone Wolf

Don't be a one person wolf pack. If for some reason we have a project with only one active team member, they should have PRs reviewed by another Sparkboxer. This gives that user someone else to bounce ideas off of and have some discussion about the project. It also keeps at least one other person up to speed on the project.
@@ -1,49 +1,47 @@
Markdown
========
# Markdown

[![The Markdown Mark][producti]][product]

Markdown is a terse markup langauge that produces HTML.

Style
-----
## Style

* Prefer footnotes to inline [links][links]

```markdown
// bad
Sweet [link](http://linkzilla.biz) coming.
```markdown
// bad
Sweet [link](http://linkzilla.biz) coming.

// good
Sweet [link][link] coming.
// good
Sweet [link][link] coming.

[link]: http://linkzilla.biz
[link]: http://linkzilla.biz

// also good
Sweet [link][] coming.
// also good
Sweet [link][] coming.

[link]: http://linkzilla.biz
```
[link]: http://linkzilla.biz
```

* Use hash marks for consistent header markup

```markdown
// bad
Hey There Big Boy
=================
```markdown
// bad
Hey There Big Boy
=================

Check Out My H2
---------------

### Inconsistent H3
## Check Out My H2

// good
# Hey There Big Boy
### Inconsistent H3

## Check Out My H2

### My H3 looks like everything else now
```
// good

# Hey There Big Boy

## Check Out My H2

### My H3 looks like everything else now
```

[product]: http://daringfireball.net/projects/markdown/
[producti]: http://i.imgur.com/TUYGZBI.png
@@ -1,31 +1,32 @@
Pattern Libraries
=====
# Pattern Libraries

What do we consider a "[pattern library](https://seesparkbox.com/foundry/building_pattern_libraries_in_react_with_storybook)" to be, exactly? At Sparkbox, our pattern libraries typically consist of all of the "components" that make up a project. We usually combine those components into larger pieces or entire "pages" so that we have some kind of static representation of how the components are used.

Ultimately, what we end up with is a guide for those who are implementing those static components and pages into larger systems, and those who will use our components to build off of in the future.

Keep in mind: you're creating a living tool to give guidance to others. Put into a pattern library what you would hope to get out of a pattern library if you were building new components or pages in a project.

Tools
-----
## Tools

### Current tools

We currently use [Downpour](https://github.com/sparkbox/downpour), which is our own implementation of Cloud Four's [Drizzle](https://github.com/cloudfour/drizzle) tool. Downpour and Drizzle are JavaScript-based tools that use [Handlebars](http://handlebarsjs.com/) for templating.

For React-based projects, we've used [React Storybook](https://storybook.js.org/)

### Other tools

- [Fabricator](https://fbrctr.github.io/)
- [Pattern Lab](http://patternlab.io/)

Naming Conventions
-----
## Naming Conventions

### Naming Overview

When naming a component, first try to think about the places where the component will be used, and if variants of that component will need to be created. If a component is likely to be used in more than one place or in more than one context, you may want to be a bit more generic when naming it.

If you're creating a very generic component — a "button" component, perhaps — you should create a "buttons" directory in your project, and then create a `base` file that will allow you to create variations off of the base component by passing Handlebars literal values into it (ex: `{{agree_button "My Text" class="my-class" visible=true counter=4}}`)

### UI & Other Components

A project's pattern library reflects the vocabulary of both the project itself and the organization. When naming components that reflect the project's UI, you might find it helpful to consult the design comp, and to talk with the rest of your team and even the client.
@@ -1,17 +1,14 @@
Rails
=====
# Rails

[![The Ruby on Rails Logo][producti]][product]

We use Ruby on Rails as the back-end for most of our custom apps.
We use Ruby on Rails as the back-end for many of our custom apps.

Style
-----
## Style

* Follow the [The Rails Style Guide][rails_style].

Gems
----
## Gems

We use these gems in most of our projects.

@@ -21,8 +18,7 @@ We use these gems in most of our projects.
* [SASS](http://sass-lang.com/) for CSS
* [Simple Form](https://github.com/plataformatec/simple_form) for forms

Services
--------
## Services

We use these services with our Rails projects.

@@ -1,12 +1,10 @@
Readme
======
# Readme

The `README.md` file in our project's root folder is the central location for
all information about the project. The template below is the starting point for
all new projects at Sparkbox.

Template
--------
## Template

A file in the root of your project called `README.md`.

@@ -1,16 +1,13 @@
Ruby
====
# Ruby

[![The Ruby Gem][producti]][product]

Ruby is often our back-end language of choice. We use [Ruby on Rails][rails] for the server side implementation on many of our custom applications.

Style
-----
## Style

* Follow the [The Ruby Style Guide][ruby_style].


[product]: http://www.ruby-lang.org/en/
[producti]: http://i.imgur.com/EUW07BU.gif
[rails]: ../rails/README.md
@@ -1,5 +1,4 @@
Naming Conventions
=====
# Naming Conventions

We follow [SMACSS](http://smacss.com/) conventions when naming CSS classes.
When you are naming something, **do not** name it based on its content, as this will be difficult to
@@ -49,4 +48,4 @@ So if a subcomponent requires special styling inside of an alternate module, do
.even-grid--image {}
```

For more information, please reference [documentation on the SMACSS website](http://smacss.com/).
For more information, please reference [documentation on the SMACSS website](http://smacss.com/).
@@ -1,12 +1,11 @@
Culture
=======
# Culture

At its core, Sparkbox is our people. We exist to inspire and build a better web. We do this through our work with customers—crafting beautiful web products that inspire others to build right. We do this by sharing what we know—on [the Foundry](../foundry), in our Build Right trainings and workshops, and by speaking at industry events and writing for industry publications. We also do this by running apprenticeships—finding people who share our desire but lack our experience and pouring into them for the first six months of each year.

Every new initiative is considered through this lens: whether it will inspire and empower a Web built right.

Every new initiative is considered through this lens: whether it will inspire and empower a Web built right.

## The Sparkbox Code of Conduct

Sparkbox is dedicated to providing inclusive, harassment-free, work environment for everyone, regardless of gender, gender identity and expression, age, sexual orientation, disability, physical appearance, body size, race, ethnicity, or religion or lack thereof.
We expect everyone to fully comply with these ideals at Sparkbox whenever they are representing the company. This includes when you are at the office (or your primary place of work) or when you are traveling for Sparkbox. This also includes when you are participating in social media or other industry related activities (ex: Github).
Don’t be nasty or mean—be considerate and respectful.
@@ -1,5 +1,4 @@
Food & Drink
============
# Food & Drink

- **Friday Lunches**
- **Snacks**
@@ -1,5 +1,4 @@
How We Play
============
# How We Play

- **Volley Pong**
- **Parties**
@@ -1,5 +1,4 @@
Knowledge Sharing
=================
# Knowledge Sharing

- **[Foundry](../../foundry)**
- **Apprenticeships**
@@ -1,5 +1,4 @@
Our Foundation
==============
# Our Foundation

- **Values**
- Fluency
@@ -12,6 +11,6 @@ Our Foundation
- **KYC**
- **Inclusiveness**
- What is acceptable behavior?
- How can we make *everyone* feel welcome?
- How can we make _everyone_ feel welcome?
- Where to have sensitive conversations
- **Benefits & Handbook**
@@ -1,5 +1,4 @@
Our Space
=========
# Our Space

- **Device Wall**
- **Makerbox**
@@ -1,5 +1,4 @@
Foundry
=======
# Foundry

* **[Foundry Governance](foundry_governance.md)**
* **[Foundry Composition](Foundry-composition.md)**
- **[Foundry Governance](foundry_governance.md)**
- **[Foundry Composition](Foundry-composition.md)**
@@ -1,4 +1,3 @@
Server Hosting
===============
# Server Hosting

[See this document for server naming conventions](naming_conventions/servers.md)

0 comments on commit 844dccb

Please sign in to comment.
You can’t perform that action at this time.