Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Commit

Permalink
docs: fix broken Markdown headings
Browse files Browse the repository at this point in the history
Closes #125
  • Loading branch information
bryant1410 authored and gkalpak committed Apr 27, 2017
1 parent 8c87b79 commit aab2964
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ send us a Pull Request. Following these steps will help us to include your code:
12. Celebrate your contribution to AngularHint! Thank you!
##<a name="style"></a> Coding Style Guidelines
## <a name="style"></a> Coding Style Guidelines
To help keep the code in AngularHint consistent, please follow these conventions.
###1. AngularHint Guidelines
### 1. AngularHint Guidelines
#### Naming
- AngularHint should be referred to as 'Angular Hint' in titles. In bodies of text it should
Expand All @@ -127,7 +127,7 @@ send us a Pull Request. Following these steps will help us to include your code:
- Instead of complex inheritance heirarchies, use simple objects.
- Prefer functions and closures to objects.

####<a name="commit"></a> Commit guidelines
#### <a name="commit"></a> Commit guidelines

Commit messages help us to create a dynamic record of changes to our code. By making
readable and consistent commit messages, we automatically document our coding decisions.
Expand Down Expand Up @@ -182,7 +182,7 @@ send us a Pull Request. Following these steps will help us to include your code:
The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.
###2. <a name="module"></a> AngularHint Module Guidelines
### 2. <a name="module"></a> AngularHint Module Guidelines
AngularHint is designed to be a modular tool. This way, independent AngularHint modules can be developed as standalone projects and later included in the overall AngularHint collection. We hope this will encourage the development
of further AngularHint modules that cover different facets of AngularJS.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ $ yarn install
```shell
$ yarn build
```
##Example
## Example
In the `example` directory, you can find a sample application that appears
superficially correct but violates many Angular best practices. When AngularHint is in operation
it produces hints for correcting the sample application. In the `correctExample` directory
Expand Down

0 comments on commit aab2964

Please sign in to comment.