diff --git a/pages/contributing/CONTRIBUTING.md b/pages/contributing/CONTRIBUTING.md deleted file mode 100644 index 04d5194..0000000 --- a/pages/contributing/CONTRIBUTING.md +++ /dev/null @@ -1,61 +0,0 @@ -## Conding Style Guide -Run `npm test`, after the tests `tslint` will run. To run tslint alone use `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 autofixes. - -The project uses conventional changelog with angular style. -[Read more about messages here](https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/master/convention.md). - -## Bug Fixes -A bug fix: - - [ ] Has code fix - - [ ] Has unit tests, all tests pass - - [ ] Updates the README.md (If necessary) - -Commits are made using: `git commit`, and the commit text in vim follows the pattern: -``` -fix: fix async tests not detected - -Fix treating class methods with a `done` parameter as asynchronous tests. - -BREAKING CHANGE: Any existing synchronous tests, writen while using the previous (broken) version, that had 'accidently' a `done` parameter, will now be executed as asynchronous. -``` - -## New Features -A feature: - - [ ] Has the necessary fix - - [ ] Has unit tests, all tests pass - - [ ] Is described in the README.md - -Commits are made using `git commit`, and the commit text in vim follows the mattern: -``` -feat: static `before`/`after` methods run before/after the suite - -Add a support for static methods named `before` or `after` in a test class, to execute as if `before` or `after` mocha hooks. Providing a `done` argument or returning a promise will run these methods as asynchronos. `@timeout` and `@slow` can be applied on `before` or `after` methods. - -BREAKING CHANGE: Any existing static `before` or `after` methods in test class will now be executed as `before` or `after` hooks. As workaround - rename these methods. -``` - -## Other -### Refactor -Typos, reorganizing code that should not break anything etc. -``` -refactor: Move method A before method B -``` - -### -Updating README.md, version patch commits, etc. -``` -chore: bump version to 1.1.15 -``` - -## Maintainers -### Publishing -Publishing prerequisits: - - The `package.json` version must have been bumped. - - Tag the commit locally. For example `git tag v1.1.17`. The version must match exactly the version in the `package.json`. - - Run `npm run changelog` and edit by hand if necessary the `CHANGELOG.md`, commit, push. - - The commit to be published must have all green github CI builds. - - Run `git clean -xdf`, `git reset --hard`, `npm i`, `npm test` locally. - -When you have this in place: - - Publish `npm publish`. - - Push the tag to the origin. For example `git push origin v1.1.17`. diff --git a/pages/contributing/barfoo.md b/pages/contributing/barfoo.md deleted file mode 100644 index 5847014..0000000 --- a/pages/contributing/barfoo.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: contributing -section: contributing -role: page -order: 2 -title: Barfoo Contributing -label: Barfoo -description: | - Everything about contributing barfoo ---- - -This is the contributing/barfoo section - diff --git a/pages/contributing/coding_style.md b/pages/contributing/coding_style.md new file mode 100644 index 0000000..dfbadb2 --- /dev/null +++ b/pages/contributing/coding_style.md @@ -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. diff --git a/pages/contributing/foobar.md b/pages/contributing/foobar.md deleted file mode 100644 index 2af3537..0000000 --- a/pages/contributing/foobar.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: contributing -section: contributing -role: page -order: 1 -title: Foobar Contributing -label: Foobar -description: | - Everything about contributing foobar ---- - -This is the contributing/foobar section - diff --git a/pages/contributing/index.md b/pages/contributing/index.md index edd4090..3619893 100644 --- a/pages/contributing/index.md +++ b/pages/contributing/index.md @@ -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. diff --git a/pages/contributing/pull_requests.md b/pages/contributing/pull_requests.md index 9428418..bb147a6 100644 --- a/pages/contributing/pull_requests.md +++ b/pages/contributing/pull_requests.md @@ -1,6 +1,57 @@ --- layout: contributing +section: contributing +role: page +toc: true +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) + +#### 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 below + - [ ] 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. +``` diff --git a/pages/contributing/reporting.md b/pages/contributing/reporting.md new file mode 100644 index 0000000..a33cd3b --- /dev/null +++ b/pages/contributing/reporting.md @@ -0,0 +1,94 @@ +--- +layout: contributing +section: contributing +role: page +toc: true +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. +```