Skip to content

Commit eab53fe

Browse files
committed
Added issue templates and updated README.rst
1 parent c5b8f64 commit eab53fe

File tree

5 files changed

+105
-4
lines changed

5 files changed

+105
-4
lines changed

.ci/travis_build_conda.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ for f in conda/dist/noarch/domdf_python_tools-*.tar.bz2; do
3131
fi
3232
done
3333

34-
34+
exit 0

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: domdfcoding
7+
8+
---
9+
10+
<!-- Have you searched for similar issues? Before submitting this issue, please check the open issues and add a note before logging a new issue.
11+
12+
PLEASE USE THE TEMPLATE BELOW TO PROVIDE INFORMATION ABOUT THE ISSUE.
13+
INSUFFICIENT INFO WILL GET THE ISSUE CLOSED. IT WILL ONLY BE REOPENED AFTER SUFFICIENT INFO IS PROVIDED-->
14+
15+
## Description
16+
<!--Provide a brief description of the issue-->
17+
18+
19+
## Steps to Reproduce
20+
<!--Please add a series of steps to reproduce the issue-->
21+
22+
1.
23+
2.
24+
3.
25+
26+
## Actual result:
27+
<!--Please add screenshots if needed and include the Python traceback if present-->
28+
29+
30+
## Expected result:
31+
32+
33+
## Reproduces how often:
34+
<!--[Easily reproduced/Intermittent issue/No steps to reproduce]-->
35+
36+
37+
## Version
38+
39+
* Operating System:
40+
* Python:
41+
* domdf_python_tools:
42+
43+
## Installation source
44+
<!-- e.g. Github repository, Github Releases, PyPI/pip, Anaconda/conda -->
45+
46+
47+
## Other Additional Information:
48+
<!--Any additional information, related issues, extra QA steps, configuration or data that might be necessary to reproduce the issue-->
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: "enhancement"
6+
assignees: ""
7+
8+
---
9+
10+
<!-- Have you searched for similar issues? Someone may already be working on the feature you are guggesting. Before submitting this issue, please check the open issues and add a note before logging a new issue.
11+
12+
PLEASE USE THE TEMPLATE BELOW TO PROVIDE INFORMATION ABOUT THE ISSUE.
13+
INSUFFICIENT INFO WILL GET THE ISSUE CLOSED. IT WILL ONLY BE REOPENED AFTER SUFFICIENT INFO IS PROVIDED-->
14+
15+
16+
## Description
17+
<!--Provide a clear and concise description of what the problem is and the improvement you are suggesting-->
18+
19+
<!--Please add screenshots if needed-->
20+
21+
22+
## Version
23+
24+
* Operating System:
25+
* Python:
26+
* domdf_python_tools:
27+
28+
29+
## Other Additional Information:
30+
<!--Any additional information, related issues, etc.-->
31+
32+
33+

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,5 @@ fabric.properties
136136
.idea
137137
build
138138
*.egg-info
139-
*/__pycache__
139+
**/__pycache__
140+
*/conda

README.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ domdf_python_tools
1414
.. image:: https://img.shields.io/pypi/pyversions/domdf_python_tools.svg
1515
:target: https://pypi.org/project/domdf_python_tools/
1616
:alt: PyPI - Python Version
17+
.. image:: https://img.shields.io/conda/v/domdfcoding/domdf_python_tools
18+
:alt: Conda
19+
:target: https://anaconda.org/domdfcoding/domdf_python_tools
1720
.. image:: https://coveralls.io/repos/github/domdfcoding/domdf_python_tools/badge.svg?branch=master
1821
:target: https://coveralls.io/github/domdfcoding/domdf_python_tools?branch=master
1922
:alt: Coverage
@@ -25,7 +28,23 @@ domdf_python_tools
2528

2629
Helpful functions for Python
2730

31+
|
2832
29-
.. conda install domdf_python_tools --channel http://conda.anaconda.org/domdfcoding
33+
Installation
34+
--------------
35+
36+
``domdf_python_tools`` can be installed from PyPI or Anaconda.
37+
38+
To install with ``pip``:
39+
40+
.. code-block:: bash
41+
42+
$ python -m pip install domdf_python_tools
43+
44+
To install with ``conda``:
45+
46+
.. code-block:: bash
47+
48+
$ conda config --add channels http://conda.anaconda.org/domdfcoding
49+
$ conda install domdf_python_tools
3050
31-
.. conda config --add channels http://conda.anaconda.org/domdfcoding

0 commit comments

Comments
 (0)