Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
halvardssm committed Jun 1, 2020
0 parents commit 6b08dde
Show file tree
Hide file tree
Showing 14 changed files with 1,118 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing

This is a community project where every contribution is appreciated!

There is a simple process to follow no matter if you are facing an bug, have an idea, or simply have a question.

## Process of issue filing

Check if there is an existing issue covering your intention.

1. if you have the same problem but the outcome is different (or vice versa), add a comment stating the difference
2. if you have the exact same problem add a like (:+1:)
3. otherwise create a new issue

### Bugs

When facing a bug, give steps to reproduce as well as the error. If you have a hypothesis to why this issue erupted, mention this. If you have already isolated the issue and have found a fix, you can open a PR.

When you have a problem, these steps will often help:

* Make sure you use the latest version of Deno
* Add the `-r` or `--reload` flag to the Deno command to reload the cache

### Ideas

Ideas are always welcome, and if there is a good reason and/or many users agree, there is a good chance it will be incorporated. Before making a PR, get feedback from the maintainers and comunity.

### Questions

If you can't find the answers in one of the open (or closed) issues, create a new one. If this project gains enough traction, a discord server will be created, until then you can use the issues.

## When creating a PR

Before pushing commits, go through this checklist:

* You have run `deno fmt`
* All tests are running successfully

For a PR to be accepted, the following needs to be applied:

* Add tests where applicable
* Pipeline is green
* Nothing more than what the PR is supposed to solve is changed (unless discussed and approved)

## Testing

Run `deno test`
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These are supported funding model platforms

ko_fi: halvardssm
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] Title"
labels: bug
assignees: ''

---

**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 or error log**
If applicable, add screenshots or error log to help explain your problem.

**System (please complete the following information):**

- OS: [e.g. macos]
- Deno version [e.g. 1.0.0]
- Module version [e.g. 1.0.0]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[IDEA] Idea title"
labels: idea
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what you would like to propose.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question
about: Question template
title: "[QUESTION] Question title"
labels: question
assignees: ''

---

Your question
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: CI

on:
push:
branches:
- master
pull_request:
branches:
- master
release:
types: [ published ]

jobs:
tests:
name: Run tests
runs-on: ubuntu-latest

steps:
- name: Clone repo
uses: actions/checkout@master
- name: Install deno
uses: denolib/setup-deno@master
with:
deno-version: 1.0.3
- name: Check formatting
run: deno fmt --check
- name: Run tests
run: deno test
Loading

0 comments on commit 6b08dde

Please sign in to comment.