diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..3a61a980 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +## What does this PR do? + +## GitHub issue or Phabricator ticket number? + +## How has this been tested? + +## Checklist before merging + +- [ ] If have added tests. +- [ ] Is this a new feature? If yes, please write one phrase about this update. +- [ ] I've attached relevant screenshots (if relevant). diff --git a/.github/workflows/.github/pull_request_template.md b/.github/workflows/.github/pull_request_template.md new file mode 100644 index 00000000..e69de29b diff --git a/.github/workflows/CODEOWNERS b/.github/workflows/CODEOWNERS new file mode 100644 index 00000000..c273eb7f --- /dev/null +++ b/.github/workflows/CODEOWNERS @@ -0,0 +1,2 @@ +# This repo is owned by the Core team +* @Screenly/core diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 380c477a..ac5986ed 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,5 +1,9 @@ name: Lint -on: push +on: + push: + paths: + - 'src/**' + - 'Cargo.toml' jobs: lint: diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index d54fa2fd..d0135855 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -2,9 +2,17 @@ name: Rust on: push: - branches: [ "master" ] + branches: + - master + paths: + - 'src/**' + - 'Cargo.toml' pull_request: - branches: [ "master" ] + branches: + - master + paths: + - 'src/**' + - 'Cargo.toml' env: CARGO_TERM_COLOR: always @@ -15,8 +23,8 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - name: Build - run: cargo build --verbose - - name: Run tests - run: cargo test --verbose + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose diff --git a/README.md b/README.md index e510a66e..26de8feb 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ -# cli \ No newline at end of file +# Screenly Command Line Interface (CLI) + +The purpose of Screenly's CLI is to make developer's life easier. Using our CLI, users are able to quickly interact with Screenly through their terminal. Morover, this CLI is built such that it can be used for automating tasks.