Merge pull request #158 from AetherModel/develop

push changes into run in 1d branch

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +25,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **System information (please complete the following information):**
- - OS: [e.g. iOS]
- - Compilers used, with version numbers
- - Otheer details about your setup that could be relevant
+
+- OS: (e.g. MacOS, Linux distribution, etc.)
+- Compilers used, with version numbers
+- Otheer details about your setup that could be relevant
 
 **Additional context**
 Add any other context about the problem here.

CONTRIBUTING.md

@@ -1,12 +1,21 @@
-Contributing
-============
-
-Code
-----
+# Contributing
 
 Please read the [standards document](doc/design/standards) before
 contributing.
 
+- [Contributing](#contributing)
+  - [Code](#code)
+    - [Development](#development)
+      - [Using AStyle](#using-astyle)
+      - [Linting](#linting)
+  - [Commit Styling](#commit-styling)
+  - [Pull Requests](#pull-requests)
+  - [Issues](#issues)
+
+---
+
+## Code
+
 ### Development
 
 Make new branches for features `git checkout -b my_feature` and commit often
@@ -16,16 +25,15 @@ you have something that works.
 #### Using AStyle
 
 We have started using astyle to format the code.  Please see
-http://astyle.sourceforge.net/. There is a style file in the root directory
-of Aether, called .astylerc.  To run this, do:
+<http://astyle.sourceforge.net/>. There is a style file in the root directory of
+Aether, called .astylerc.  To run this, do:
 
 AStyle --project=.astylerc src/*.cpp
 
 on WSL with Ubuntu, the command seems to be:
 
 astyle --options=.astylerc src/*.cpp
 
-
 #### Linting
 
 For *C++* code make sure to use a static code checker like
@@ -44,13 +52,13 @@ python3 -m pip cpplint
 python3 -m pip --user cpplint
 ```
 
-Using a linter in an editor is a good supplement, but not a replacement for the static linters. 
-The linter in the 'atom' editor requires that you install the `linter` and `gcc-linter` packages. 
-Atom also has additional packages `whitespaces` and `tabs-to-spaces`
-to automatically remove whitespaces at the end of the lines, and
-convert tabs to spaces.
+Using a linter in an editor is a good supplement, but not a replacement for the
+static linters. The linter in the 'atom' editor requires that you install the
+`linter` and `gcc-linter` packages. Atom also has additional packages
+`whitespaces` and `tabs-to-spaces` to automatically remove whitespaces at the
+end of the lines, and convert tabs to spaces.
 
-### Commit Styling
+## Commit Styling
 
 The first line of the commit must be *at most* ~50 characters long and
 should start with either.
@@ -74,25 +82,24 @@ For example,
 
 *do:*
 
-```
+```github
 FEAT: Hydrostatic density implementation.
 ```
 
 *don't:*
 
-```
+```github
 Implemented hydrostatic density. (feature)
 ```
 
-### Pull Requests
+## Pull Requests
 
 Make sure you have linted and checked your code before asking for a
 pull request. Before requesting a review, ensure the pull request
 check list has been completed.  Another member must check the code and
 approve it before merge.
 
-Issues
-------
+## Issues
 
 *Issues* are reporting bugs, feature requests, or goals for the
 project. In order to submit an issue make sure it follows the [issue