Skip to content

Commit

Permalink
Merge pull request #60 from ApplauseOSS/dev
Browse files Browse the repository at this point in the history
Add CODEOWNERs and contribution information
  • Loading branch information
rconner46 authored Oct 8, 2024
2 parents 0c4a8d1 + 5d001d6 commit 4928e53
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###
# NOTE: this file is auto-generated and any changes will be overwritten
###

/.github/ @ApplauseOSS/ops
39 changes: 39 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing
Please fork, add specs, and send pull requests! Do keep in mind that this is a generic project, so please keep your specs as generic as possible so they can be re-used in other projects.


## Code format & ESLint
The project contains a [editorconfig](http://editorconfig.org/) and [eslint](http://eslint.org/) configuration file, builds will run ESLint with this configuration. To run ESLint localy use the following command:

```sh
npm run test:lint
```


### Testing commands
As stated above the command for validating the code using ESLint is:

```sh
npm run test:lint
```

To run all unit tests use the following command:

```sh
npm run test:unit
```

To run the Cucumber Boilerplate feature tests use:

```sh
npm run test:features
```

To run the complete test suite run:

```sh
npm run test
```

## Note
Currently not all [WebdriverIO](http://webdriver.io/) commands are mapped and implemented as snippets. Any contributions that adds new snippets + test are highly welcome.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Issue description
> Please provide a brief description of the problem you are experiencing
# Steps to reproduce
> How can you reproduce the issue you are facing?
# Expected behavior
> What did you expect to happen?
# Actual behavior
> What did happen?
# Issue occurred on browser/platform
> What platform did you experience this issue on? If you tested multiple browsers/platforms please add them, if you did not experience the issue on other tested browsers or platforms note it as well.
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contribution description
> Please add a brief description of the contents of the pull request
# Pull request checklist
- [ ] Contributed code respects the [editorconfig rules](.editorconfig)
- [ ] Contributed code passes the [eslint rules](.eslintrc.yaml)
- [ ] Added rules are described in the [readme file](README.md)

0 comments on commit 4928e53

Please sign in to comment.