Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #40

Merged
merged 4 commits into from
Dec 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 36 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,43 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

title: ""
labels: "bug"
assignees: ""
---

**Describe the bug**
## Describe the bug

A clear and concise description of what the bug is.

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

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

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

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
## To Reproduce (Example)

**I try it:**

```py
print(1 + '2')
```

**And then get this Erro:**

```shell
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: unsupported operand type(s) for +: 'int' and 'str'
```

**But I wanted it:**

```py
print(1 + '2')
# 3
```

## Screenshots

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

## Anvironment (please complete the following information):

- OS: iOS, Win, Ubuntu
- Version: 13.4, 11, 21.10
28 changes: 18 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: olivmath

title: ""
labels: ""
assignees: ""
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Describe a new Feature

- [ ] A clear and concise description of the new feature
- [ ] Some context about WHY you want this new feature

## Describe what you expect! (Example)

**I want Merkly to work like this:**

```py
import merkly

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
data = []
result = merkly.new_feature(data)

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
assert result == ["new data very cool"]
```
24 changes: 23 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
# 🚨 Should be `squash commit`
# ❤️ Thanks for adding a leaf to our tree! 🌳

<!-- # ✅ Done for review #<NUMBER OF ISSUE>-->

## Before submitting this PR, please make sure that:

- [ ] Your code is running WITHOUT ERRORS or WARNINGS
- [ ] You have added TEST to your code
- [ ] Link this PR with Issue, if applicable

## Describe your changes

A clear and concise description of what you want

## Show how to use your feature!

```python
import merkly

print(merkly)
```

# Welcome to the Merkly Community! 🌱
Loading