Skip to content

Commit ba8e858

Browse files
authored
Merge pull request #155 from AetherModel/dipole_again
[FEAT]: Dipole grid and 1D improvements
2 parents 6c2ac72 + 2b973e9 commit ba8e858

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+3897
-864
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
1414
Steps to reproduce the behavior:
15+
1516
1. Go to '...'
1617
2. Click on '....'
1718
3. Scroll down to '....'
@@ -24,9 +25,10 @@ A clear and concise description of what you expected to happen.
2425
If applicable, add screenshots to help explain your problem.
2526

2627
**System information (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Compilers used, with version numbers
29-
- Otheer details about your setup that could be relevant
28+
29+
- OS: (e.g. MacOS, Linux distribution, etc.)
30+
- Compilers used, with version numbers
31+
- Otheer details about your setup that could be relevant
3032

3133
**Additional context**
3234
Add any other context about the problem here.

CONTRIBUTING.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
Contributing
2-
============
3-
4-
Code
5-
----
1+
# Contributing
62

73
Please read the [standards document](doc/design/standards) before
84
contributing.
95

6+
- [Contributing](#contributing)
7+
- [Code](#code)
8+
- [Development](#development)
9+
- [Using AStyle](#using-astyle)
10+
- [Linting](#linting)
11+
- [Commit Styling](#commit-styling)
12+
- [Pull Requests](#pull-requests)
13+
- [Issues](#issues)
14+
15+
---
16+
17+
## Code
18+
1019
### Development
1120

1221
Make new branches for features `git checkout -b my_feature` and commit often
@@ -16,16 +25,15 @@ you have something that works.
1625
#### Using AStyle
1726

1827
We have started using astyle to format the code. Please see
19-
http://astyle.sourceforge.net/. There is a style file in the root directory
20-
of Aether, called .astylerc. To run this, do:
28+
<http://astyle.sourceforge.net/>. There is a style file in the root directory of
29+
Aether, called .astylerc. To run this, do:
2130

2231
AStyle --project=.astylerc src/*.cpp
2332

2433
on WSL with Ubuntu, the command seems to be:
2534

2635
astyle --options=.astylerc src/*.cpp
2736

28-
2937
#### Linting
3038

3139
For *C++* code make sure to use a static code checker like
@@ -44,13 +52,13 @@ python3 -m pip cpplint
4452
python3 -m pip --user cpplint
4553
```
4654

47-
Using a linter in an editor is a good supplement, but not a replacement for the static linters.
48-
The linter in the 'atom' editor requires that you install the `linter` and `gcc-linter` packages.
49-
Atom also has additional packages `whitespaces` and `tabs-to-spaces`
50-
to automatically remove whitespaces at the end of the lines, and
51-
convert tabs to spaces.
55+
Using a linter in an editor is a good supplement, but not a replacement for the
56+
static linters. The linter in the 'atom' editor requires that you install the
57+
`linter` and `gcc-linter` packages. Atom also has additional packages
58+
`whitespaces` and `tabs-to-spaces` to automatically remove whitespaces at the
59+
end of the lines, and convert tabs to spaces.
5260

53-
### Commit Styling
61+
## Commit Styling
5462

5563
The first line of the commit must be *at most* ~50 characters long and
5664
should start with either.
@@ -74,25 +82,24 @@ For example,
7482

7583
*do:*
7684

77-
```
85+
```github
7886
FEAT: Hydrostatic density implementation.
7987
```
8088

8189
*don't:*
8290

83-
```
91+
```github
8492
Implemented hydrostatic density. (feature)
8593
```
8694

87-
### Pull Requests
95+
## Pull Requests
8896

8997
Make sure you have linted and checked your code before asking for a
9098
pull request. Before requesting a review, ensure the pull request
9199
check list has been completed. Another member must check the code and
92100
approve it before merge.
93101

94-
Issues
95-
------
102+
## Issues
96103

97104
*Issues* are reporting bugs, feature requests, or goals for the
98105
project. In order to submit an issue make sure it follows the [issue

0 commit comments

Comments
 (0)