Skip to content

Commit

Permalink
Merge pull request #28 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 6decfa8 + 4d7b141 commit 447a3aa
Show file tree
Hide file tree
Showing 7 changed files with 105 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)
37 changes: 37 additions & 0 deletions .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@

name: Node.js CI

on:
push:
branches: [ master ]
pull_request:
branches: [ '**' ]

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
cache: 'yarn'
- run: ./scripts/build.sh

#==============================================================================
# UNCOMMENT THIS SECTION ONCE WE HAVE PUBLISHING TO NPM.ORG
#==============================================================================

# - run: yarn install --frozen-lockfile
# - run: yarn lint-verify
# - run: yarn build
# - run: yarn test
# - run: yarn publish-verify
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"scripts": {
"clean": "rm -rf ./dist/",
"lint": "eslint ./src/ ./test/ --fix",
"lint-verify": "eslint ./src/ ./test/",
"build": "rollup -c --bundleConfigAsCjs",
"test": "cross-env NODE_OPTIONS=\"--loader ts-node/esm\" cucumber-js test/features/smoke/smoke.feature -p default"
},
Expand Down
2 changes: 2 additions & 0 deletions scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
# exit when any command fails
set -e
git clean -fx -d
yarn install
yarn lint-verify
yarn build
yarn test
if [[ `git status --porcelain` ]]; then
Expand Down

0 comments on commit 447a3aa

Please sign in to comment.