Skip to content
Permalink
Browse files

Linked CODING_GUIDELINES.md to CONTRIBUTING.md

  • Loading branch information...
kylelobo committed Jun 7, 2019
1 parent 628af05 commit 6e1b8fefdac480951c9c407a46c19263ed1de0c7
Showing with 8 additions and 5 deletions.
  1. +8 −5 CONTRIBUTING.md
@@ -1,7 +1,10 @@
# Contributing Guide

- Contributing to The Documentation Compendium is fairly easy. This document shows you how to get started.
- The [Codebase Structure](/CODEBASE_STRUCTURE.md) has detailed information about how the various files in this project are structured.
- Contributing to The Documentation Compendium is fairly easy. This document shows you how to get started

## General
- The [Codebase Structure](/CODEBASE_STRUCTURE.md) has detailed information about how the various files in this project are structured
- Please ensure that any changes you make are in accordance with the [Coding Guidelines](/CODING_GUIDELINES.md) of this repo

## Submitting changes

@@ -18,9 +21,9 @@
````
- Use one branch per fix / feature
- Commit your changes
- Please provide a git message that explains what you've done.
- Please provide a git message that explains what you've done
- Please make sure your commits follow the [conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
- Commit to the forked repository.
- Commit to the forked repository
- Example:
````
$ git commit -am 'Add some fooBar'
@@ -31,7 +34,7 @@
$ git push origin feature/fooBar
````
- Make a pull request
- Make sure you send the PR to the <code>fooBar</code> branch.
- Make sure you send the PR to the <code>fooBar</code> branch
- Travis CI is watching you!

If you follow these instructions, your PR will land pretty safely in the main repo!

0 comments on commit 6e1b8fe

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