Skip to content

Commit

Permalink
feature #26: contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
silkentrance committed Apr 8, 2019
1 parent 6fd5105 commit 9a64d93
Show file tree
Hide file tree
Showing 7 changed files with 164 additions and 90 deletions.
61 changes: 0 additions & 61 deletions pages/contributing/CONTRIBUTING.md

This file was deleted.

13 changes: 0 additions & 13 deletions pages/contributing/barfoo.md

This file was deleted.

15 changes: 15 additions & 0 deletions pages/contributing/coding_style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: contributing
section: contributing
role: page
order: 30
title: Coding Style
label: Coding Style
description: |
Coding Style
---

## Coding Style

Run tslint using `npm run tslint`. There is also a `npm run tslint-fix` that will apply auto fixes for some issues,
but this may also break stuff, make sure to commit your code before running auto fixes.
13 changes: 0 additions & 13 deletions pages/contributing/foobar.md

This file was deleted.

6 changes: 4 additions & 2 deletions pages/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ role: index
order: 3
label: Contributing
description: |
Everything about contributing
Contributing to testdeck
---

This is the contributing section
## Contributing

See the available guides for more information.

53 changes: 52 additions & 1 deletion pages/contributing/pull_requests.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,57 @@
---
layout: contributing
section: contributing
role: page
order: 20
title: Pull Requests
label: Pull Requests
description: |
Pull requests
---

Section about pull requests.
{:.toc}
## Pull Requests


{:.toc}
### Bug Fixes

When doing pull requests for bug fixes, you can use this short list as a reminder what needs to be done.

- [ ] [A bug report has been filed](./reporting/#bugs)
- [ ] Has the necessary changes
- [ ] Has unit tests, all tests pass
- [ ] The commit message follows the pattern shown below (we use conventional-changelog)
- [ ] Updates the README.md (If necessary)

#### Commit Message Pattern

```
fix #123: fix async tests not detected
Fix treating class methods with a `done` parameter as asynchronous tests.
BREAKING CHANGE: Any existing synchronous tests, written while using the previous (broken) version,
that had 'accidently' a `done` parameter, will now be executed as asynchronous.
```


{:.toc}
### New Features

When doing pull requests for new features, you can use this short list as a reminder what needs to be done.

- [ ] [A feature request has been filed](./reporting/#feature-requests)
- [ ] Has the necessary changes
- [ ] Has unit tests, all tests pass
- [ ] The commit message follows the pattern shown belog
- [ ] Optional: a pull request for [testdeck-site](https://github.com/testdeck/testdeck-site) that includes
documentation on the new features has been made available

#### Commit Message Pattern

```
feature #123: new super duper feature
A super duper new feature that makes testdeck fly.
```
93 changes: 93 additions & 0 deletions pages/contributing/reporting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
layout: contributing
section: contributing
role: page
order: 10
title: Reporting Issues
label: Reporting Issues
description: |
Reporting issues
---

{:.toc}
## Reporting Issues


{:.toc}
### Bugs

If you find any bugs, we do want to hear about them first. And if you know of any temporary workarounds, be sure to
include that information in your bug report as well. Of course, we'd be happy to also get a
[pull request](./pull_requests#bug-fixes) from you that fixes the issue.

#### Bug Report Form

```markdown
## Bug Report

### Testdeck Version

e.g. 0.0.5

### Testdeck Package

- [ ] `@testdeck/core`
- [ ] `@testdeck/mocha`
- [ ] `@testdeck/jasmine`
- [ ] `@testdeck/jest`
- [ ] unsure

### NodeJS Version

### Mocha / Jasmine / Jest Version

- Mocha:
- `@types/mocha`:
- Jasmine:
- `@types/jasmine`:
- Jest:
- `@types/jest`:

### Operating System

- [ ] Linux
- [ ] Mac OS X
- [ ] Windows 7
- [ ] Windows 10
- [ ] Other:

### Actual Behaviour

Shortly describe the actual behaviour.

### Expected Behaviour

Shortly describe what you thing that the expected behaviour should be.

### Additional Information

Add some additional information here, e.g. a link to your repository or a
link to a gist or even the source code required to reproduce the actual behaviour.
```


{:.toc}
### Feature Requests

If you need a new feature and believe that this should be a direct part of `testdeck`, do pitch us your idea using the
below feature request form. Of course, we'd be happy to also get a [pull request](./pull_requests#new-features) from you
that implements that feature.

#### Feature Request Form

```markdown
## Feature Request

### Testdeck Version

e.g. 0.0.5

### Description

Shortly describe the new feature.
```

0 comments on commit 9a64d93

Please sign in to comment.