info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-17 16:22:21 +02:00
Code Issues Releases Wiki Activity

Linked CODING_GUIDELINES.md to CONTRIBUTING.md

Browse Source
This commit is contained in:
Kyle Lobo
2019-06-07 23:43:29 +05:30
committed by GitHub
parent 628af053c2
commit 6e1b8fefda
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@@ -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!