Verified Commit 95490269 authored by Qusai Al Shidi's avatar Qusai Al Shidi 💬
Browse files

Should be `shell` and not `bash` for markdown language alias

parent 178dd8e6
...@@ -102,3 +102,6 @@ venv.bak/ ...@@ -102,3 +102,6 @@ venv.bak/
# mypy # mypy
.mypy_cache/ .mypy_cache/
# misc
tags
This diff is collapsed.
...@@ -8,7 +8,7 @@ Git etiquette ...@@ -8,7 +8,7 @@ Git etiquette
If you're planning on adding a feature (new function or class) then create your own branch, If you're planning on adding a feature (new function or class) then create your own branch,
```bash ```shell
$ git checkout -b my_new_feature $ git checkout -b my_new_feature
``` ```
...@@ -21,7 +21,7 @@ Coding Style: PEP 8 ...@@ -21,7 +21,7 @@ Coding Style: PEP 8
The style for your code must follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide. It would be helpful to use a linter like [pylint](https://pylint.org) to check whether your code is complying before submitting. The style for your code must follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide. It would be helpful to use a linter like [pylint](https://pylint.org) to check whether your code is complying before submitting.
```bash ```shell
$ pylint somefile.py $ pylint somefile.py
``` ```
......
...@@ -14,14 +14,14 @@ Clone into the directory you want to use it. ...@@ -14,14 +14,14 @@ Clone into the directory you want to use it.
*Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy or have a local copy do the following: *Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy or have a local copy do the following:
```bash ```shell
# Skip this if using it in SWMF directory. # Skip this if using it in SWMF directory.
$ git clone https://gitlab.umich.edu/swmf_sofware/swmfpy.git /path/to/my/dir $ git clone https://gitlab.umich.edu/swmf_sofware/swmfpy.git /path/to/my/dir
``` ```
Then install with [pip](https://pip.pypa.io/en/stable/): Then install with [pip](https://pip.pypa.io/en/stable/):
```bash ```shell
$ python3 -m pip install --user wheel # Might be necessary $ python3 -m pip install --user wheel # Might be necessary
$ python3 -m pip install --user git+https://gitlab.umich.edu/swmf_software/swmfpy.git@master $ python3 -m pip install --user git+https://gitlab.umich.edu/swmf_software/swmfpy.git@master
``` ```
......
#!/usr/bin/env bash #!/usr/bin/env bash
# Script to make the changelogs # Script to make the changelogs
git log --oneline --pretty='format:- %h **(%as, %an)**: _C%D_: %s' > CHANGELOG.markdown echo 'Changelog:' > CHANGELOG.markdown
echo '==========' >> CHANGELOG.markdown
echo '' >> CHANGELOG.markdown
echo '' >> CHANGELOG.markdown
echo 'Contributors:' >> CHANGELOG.markdown
echo '-------------' >> CHANGELOG.markdown
echo '' >> CHANGELOG.markdown
git shortlog -n -s >> CHANGELOG.markdown
echo '' >> CHANGELOG.markdown
echo 'Changes:' >> CHANGELOG.markdown
echo '--------' >> CHANGELOG.markdown
echo '' >> CHANGELOG.markdown
git log --oneline --pretty='format:- %h **(%as, %an)**: _C:%D:_ %s' >> CHANGELOG.markdown
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment