Fixed grammatical mistakes in few markdown files. (#1195)

* Fixed some grammatical mistakes, and followed some markdown linting rules.

* Updated the issue templates titles with symbols to make them look better.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
-name: Bug Report
-description: File a bug report
+name: "\U0001F41E Bug report"
+description: File a bug report to help us improve.
 title: "[Bug]: "
 labels: ["bug"]
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
-name: Feature request
-about: Suggest missing features or functionalities
+name: "🌟Feature request"
+about: Suggest missing features or functionalities for Heat
 title: ''
 labels: 'enhancement'
 assignees: ''

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,7 +9,6 @@
     - [ ] unit tests: multiple dtypes tested
     - [ ] documentation updated where needed
 
-
 ## Description
 
 <!--- Include a summary of the change/s.
@@ -19,6 +18,7 @@ Please also include relevant motivation and context. List any dependencies that
 Issue/s resolved: #
 
 ## Changes proposed:
+
 -
 -
 -
@@ -39,7 +39,7 @@ i.e.
 - with `split=None` and `split not None`
 
 This can be done using https://github.com/pythonprofilers/memory_profiler for CPU memory measurements,
-GPU measuremens can be done with https://pytorch.org/docs/master/generated/torch.cuda.max_memory_allocated.html.
+GPU measurements can be done with https://pytorch.org/docs/master/generated/torch.cuda.max_memory_allocated.html.
 These tools only profile the memory used by each process, not the entire function.
 --->
 
@@ -50,9 +50,8 @@ These tools only profile the memory used by each process, not the entire functio
 
 Python has an embedded profiler: https://docs.python.org/3.9/library/profile.html
 Again, this will only profile the performance on each process. Printing the results with many processes
-my be illegible. It may be easiest to save the output of each to a file.
+may be illegible. It may be easiest to save the output of each to a file.
 --->
 
-
 #### Does this change modify the behaviour of other functions? If so, which?
 yes / no

CODE_OF_CONDUCT.md

@@ -1,76 +1,76 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity, and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <[email protected]>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+<https://www.contributor-covenant.org/faq>

README.md

@@ -7,6 +7,7 @@
 Heat is a distributed tensor framework for high performance data analytics.
 
 # Project Status
+
 [![CPU/CUDA/ROCm tests](https://codebase.helmholtz.cloud/helmholtz-analytics/ci/badges/heat/base/pipeline.svg)](https://codebase.helmholtz.cloud/helmholtz-analytics/ci/-/commits/heat/base)
 [![Documentation Status](https://readthedocs.org/projects/heat/badge/?version=latest)](https://heat.readthedocs.io/en/latest/?badge=latest)
 [![coverage](https://codecov.io/gh/helmholtz-analytics/heat/branch/main/graph/badge.svg)](https://codecov.io/gh/helmholtz-analytics/heat)
@@ -23,7 +24,7 @@ Heat is a distributed tensor framework for high performance data analytics.
 
 Heat is a flexible and seamless open-source software for high performance data
 analytics and machine learning. It provides highly optimized algorithms and data
-structures for tensor computations using CPUs, GPUs and distributed cluster
+structures for tensor computations using CPUs, GPUs, and distributed cluster
 systems on top of MPI. The goal of Heat is to fill the gap between data
 analytics and machine learning libraries with a strong focus on single-node
 performance, and traditional high-performance computing (HPC). Heat's generic
@@ -37,7 +38,7 @@ computational and memory needs of your laptop and desktop.
 # Features
 
 * High-performance n-dimensional tensors
-* CPU, GPU and distributed computation using MPI
+* CPU, GPU, and distributed computation using MPI
 * Powerful data analytics and machine learning methods
 * Abstracted communication via split tensors
 * Python API
@@ -92,7 +93,7 @@ $ pip install heat[hdf5,netcdf,dev]
 TL;DR: [Quick Start](quick_start.md) (Read this to get a quick overview of Heat).
 
 Check out our Jupyter Notebook [**Tutorial**](https://github.com/helmholtz-analytics/heat/blob/main/scripts/)
-right here on Github or in the /scripts directory, to learn and understand about the basics and working of Heat.
+right here on GitHub or in the /scripts directory, to learn and understand about the basics and working of Heat.
 
 The complete documentation of the latest version is always deployed on
 [Read the Docs](https://heat.readthedocs.io/).

RELEASE.md

@@ -1,24 +1,28 @@
 # Releasing a new Heat version
 
-These are basic instructions for internal use. Will be expanded as need arises.
+These are basic instructions for internal use. Will be expanded as the need arises.
 
 ### Major or minor version update
+
 (e.g. 1.2 --> 1.3, or 1.3 --> 2.0)
 
 In the following, we assume we are about to release Heat v1.3.0.
 
 **PRE-REQUISITES:**
+
 - You need [PyPi](https://pypi.org/), [Test.PyPi](https://test.pypi.org/) account
-- all intended PRs are merged, all tests have passed, and the `main` branch is ready for release.
+- All intended PRs are merged, all tests have passed, and the `main` branch is ready for release.
 
 1. We will release all new features in the development branch `main`. Branch off  `main` to create a new release branch, e.g.:
+
 ```bash
 git checkout main
 git pull
 git checkout -b release/1.3.x
 ```
 
 2. Update `heat/core/version.py` like this:
+
 ```python
 """This module contains Heat's version information."""
 
@@ -35,39 +39,48 @@ extension: str = "dev" # <-- set to None
 3. Commit and push new `version.py` in `release/1.3.x`
 
 4. Draft release notes:
+
   - Go to the GitHub repo's [Releases](https://github.com/helmholtz-analytics/heat/releases) page.
   - The release notes draft is automated. Click on Edit Draft
-  - Select new tag: v1.3.0. Modify Target branch: `release/1.3.x`
+  - Select the new tag: v1.3.0. Modify Target branch: `release/1.3.x`
   - Edit release notes as needed (see older releases)
   - Click on Save but do not publish yet
 
 5. Build wheel in your local `heat/` directory, make sure you are on branch `release/1.3.x`.
+
    ```bash
    rm -f dist/*
    python -m build
    ```
+
    You might have to install the `build` package first (i.e. with `conda install build` or `pip install build`)
- 6. Upload to Test PyPI and verify things look right. You need to install `twine` first.
+6. Upload to Test PyPI and verify things look right. You need to install `twine` first.
+
     ```bash
      twine upload -r testpypi dist/*
      ```
+
     `twine` will prompt for your username and password.
- 7. When everything works, upload to PyPI:
+7. When everything works, upload to PyPI:
+
    ```bash
    twine upload dist/*
    ```
- 8. Go back to the Release Notes draft and publish them. The new release is out!
- 9. Now we want to update `main` to the latest version, and we want the version on `main` to be `1.3.0-dev`.
+
+8. Go back to the Release Notes draft and publish them. The new release is out!
+9. Now we want to update `main` to the latest version, and we want the version on `main` to be `1.3.0-dev`.
+
     ```bash
     git checkout main
     git pull
     git checkout -b workflows/update-version-main
     git merge release/1.3.x --no-ff --no-commit
     ```
-    Modify `version.py` so that `extension` is `"dev"`. Commit and push the changes.
- 11. Create a PR with `main` as base branch.
- 12. Get approval and merge. You're done!
 
+    Modify `version.py` so that `extension` is `"dev"`. Commit and push the changes.
+11. Create a PR with `main` as the base branch.
+12. Get approval and merge. You're done!
 
 ### Patch release
+
 (e.g. 1.3.1 --> 1.3.2)