Skip to content

Commit

Permalink
STY: updated markdown style
Browse files Browse the repository at this point in the history
Another attempt to placate codacy.
  • Loading branch information
aburrell committed Apr 21, 2021
1 parent 926f19b commit 8ce8696
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 42 deletions.
18 changes: 12 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,34 @@ assignees: ''

---

# Describe the bug
Describe the bug
================
A clear and concise description of what the bug is.

## To Reproduce
To Reproduce
------------
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected behavior
Expected behavior
-----------------
A clear and concise description of what you expected to happen.

## Screenshots
Screenshots
-----------
If applicable, add screenshots to help explain your problem.

## Computer
Computer
--------
Please provide the following information:
* OS: (e.g., iOS)
* Python version: (e.g., 3.6)
* Compiler with version: (e.g., gfortran 47)
* Apexpy version/branch: (e.g., 1.1.0/main)

## Additional context
Additional context
------------------
Add any other context about the problem here.
18 changes: 12 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,32 @@ labels: 'enhancement'
assignees: ''
---

# Requested feature
Requested feature
=================
A short description of what you are proposing.

## The problem or gap this feature will address
The problem or gap this feature will address
--------------------------------------------
A clear and concise description of what the problem is. For example, I'm always
frustrated when ...

## The desired solution
The desired solution
--------------------
A clear and concise description of what you want to happen. Keep the scope as
narrow as possible, to make it easier to implement

## Possible alternatives
Possible alternatives
---------------------
A clear and concise description of any alternative solutions or features you've
considered.

## Additional context
Additional context
------------------
Add any other context or screenshots about the feature request here. For
context, the apexpy version/branch you're working on, your system detail, your
python version, and your compiler (with version) may or may not be relevant.

## Reminders
Reminders
---------
This is a volunteer-driven project. Code contributions are welcome, as is help
testing new code.
23 changes: 14 additions & 9 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ assignees: ''

---

# Describe the problem or ask the question
Describe the problem or ask the question
========================================
A clear and concise description of what the problem or question is.

## Provide an example, if applicable
Expand All @@ -17,18 +18,22 @@ Steps to reproduce the behavior:
3. Scroll down to '....'
4. See behaviour

## Expectations
Expectations
------------
A clear and concise description of what you expected (or wanted) to happen.

## Screenshots
Screenshots
-----------
If applicable, add screenshots to help explain your question.

## Desktop
Computer
--------
Please complete the following information:
* OS: (e.g., iOS)
* Python version: (e.g., 3.6)
* Compiler with version: (e.g., gfortran 22)
* Apexpy version/branch: (e.g., 1.1.0/main)
* OS: (e.g., iOS)
* Python version: (e.g., 3.6)
* Compiler with version: (e.g., gfortran 22)
* Apexpy version/branch: (e.g., 1.1.0/main)

## Additional context
Additional context
------------------
Add any other context about the problem here.
42 changes: 21 additions & 21 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# Description
Description
===========

Please include a summary of the change and which issue is fixed. Please also
include relevant motivation and context. List any dependencies that are required
for this change. Please see ``CONTRIBUTING.rst`` for more guidelines.

Fixes # (issue)

## Type of change

Type of change
--------------
Please delete options that are not relevant.

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that changes existing functionality)
- This change requires a documentation update
- Release candidate

# How Has This Been Tested?
* Bug fix (non-breaking change which fixes an issue)
* New feature (non-breaking change which adds functionality)
* Breaking change (fix or feature that changes existing functionality)
* This change requires a documentation update
* Release candidate

How Has This Been Tested?
-------------------------
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details for
your test configuration

- Test A
- Test B
instructions so we can reproduce the desired behaviour.

## Test Configuration:
- Operating system: (e.g., Hal)
- Python version number: (e.g., 3.7)
- Compiler with version number: (e.g. gfortran 9.0)
- Relevant llocal setup details: (e.g., apexpy version/branch)
* Test A
* Test B

# Checklist:
### Test Configuration
* Operating system: (e.g., Hal)
* Python version number: (e.g., 3.7)
* Compiler with version number: (e.g. gfortran 9.0)
* Relevant local setup details: (e.g., apexpy version/branch)

Checklist
---------
- [ ] Make sure you are merging into the ``develop`` (not ``main``) branch
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
Expand Down

0 comments on commit 8ce8696

Please sign in to comment.