Skip to content
This repository has been archived by the owner on Jan 9, 2024. It is now read-only.

Commit

Permalink
Add issue and pull request templates and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
adithyabsk committed Nov 25, 2018
1 parent 36ee020 commit 5cc9025
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 39 deletions.
57 changes: 57 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
#### Description
<!--
Example: DropFeatures fails on categorical features when assessing a string column
-->

#### Steps/Code to Reproduce
<!--
Please add the minimum code required to reproduce the issue if possible.
Example:
```python
import uuid
import numpy as np
import pandas as pd
from foreshadow.preprocessor import Preprocessor
cat1 = [str(uuid.uuid4()) for _ in range(40)]
cat2 = [str(uuid.uuid4()) for _ in range(40)]
input = pd.DataFrame({
'col1': np.random.choice(cat1, 1000),
'col2': np.random.choice(cat2, 1000)
})
processor = Preprocessor()
output = processor.fit_transform(input)
```
If the code is too long, feel free to put it in a public gist and link it in the issue: https://gist.github.com
-->

#### Expected Results
<!--
Please add the results that you would expect here.
Example: Error should not be thrown
-->

#### Actual Results
<!--
Please place the full traceback here, again use a gist if you feel that it is too long.
-->

#### Versions
<!--
Please run the following snippet in your environment and paste the results here.
```python
import platform; print(platform.platform())
import sys; print("Python", sys.version)
import numpy; print("NumPy", numpy.__version__)
import sklearn; print("Scikit-Learn", sklearn.__version__)
import pandas; print("Pandas", pandas.__version__)
import foreshadow; print("Foreshadow", foreshadow.__version__)
from foreshadow.utils import check_transformer_imports; check_transformer_imports()
```
-->


<!--Thank you for contributing!-->
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!--
Thanks you for taking the time to submit a pull request! Please take a look at some guideliens before submitting a pull request: https://github.com/georgianpartners/foreshadow/blob/development/doc/contrib.rst
-->

### Related Issue
<!--
Example: Fixes #7. See also #35.
Please use keywords (e.g., Fixes) to create link to the issues or pull requests
you resolved, so that they will automatically be closed when your pull request
is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
-->

### Description
<!--
Please add a narrative description of your the changes made and the rationale behind them. If making a enhancement include the motivation and use cases addressed.
-->
43 changes: 4 additions & 39 deletions doc/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,8 @@ Issues
------
Please feel free to submit issues to github with any bugs you encounter, ideas you may have, or questions about useage. We only ask that you tag them appropriately as *bug fix*, *feature request*, *usage*. Please also follow the following format

.. code-block:: md
#### Description
Please add a narrative description of your issue.
#### Steps/Code to Reproduce
Please add the minimum code required to reproduce the issue if possible. If the code is too long, feel free to put it in a public gist and link it in the issue: https://gist.github.com
#### Expected Results
Please add the results that you would expect here
#### Actual Results
Please place the full traceback here
#### Versions
Please run the following snippet in your code and paste the results here.
```python
import platform; print(platform.platform())
import sys; print("Python", sys.version)
import numpy; print("NumPy", numpy.__version__)
import sklearn; print("Scikit-Learn", sklearn.__version__)
import pandas; print("Pandas", pandas.__version__)
import foreshadow; print("Foreshadow", foreshadow.__version__)
from foreshadow.utils import check_transformer_imports; check_transformer_imports()
```
.. literalinclude :: ../.github/issue_template.md
:language: md
How to Contribute: Pull Requests
--------------------------------
Expand Down Expand Up @@ -74,16 +50,5 @@ We accept pull requests! Thank you for taking the time to read this. There are o
7. Go to the github fork page and submit your pull request against the **development** branch. Please use the following template for pull requests

.. code-block:: md
### Description
Please add a narrative description of your the changes made
### Related Issue
Please add any issue that this pull request addresses
### Motivation and Context
If applicable
### Screenshots (if appropriate)
Add them here
.. literalinclude :: ../.github/pull_request_template.md
:language: md

0 comments on commit 5cc9025

Please sign in to comment.