Skip to content

Commit 71dac9d

Browse files
committed
Add CONTRIBUTING.md with guidelines for testkit repository
The contributing guide provides instructions specific to shell script development, including POSIX compliance, ShellCheck usage, and directory structure expectations. It aligns contributors to common development workflows. Signed-off-by: smuppand <[email protected]>
1 parent c897833 commit 71dac9d

File tree

2 files changed

+58
-9
lines changed

2 files changed

+58
-9
lines changed

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to the Shell Scripts Repository
2+
3+
Welcome! This repository contains hardware validation shell scripts for Qualcomm embedded robotic platform boards running Linux systems. These scripts follow POSIX standards for maximum portability and integration into CI tools like LAVA.
4+
5+
## Directory Structure
6+
7+
- `Runner/`: Root test harness
8+
- `Runner/utils/`: Shared libraries like `functestlib.sh`
9+
- `Runner/init_env`: Common environment setup
10+
- `Runner/suites/`: Functional test suites organized per feature
11+
12+
## Getting Started
13+
14+
1. Clone the repository:
15+
```bash
16+
git clone https://github.com/qualcomm-linux/qcom-linux-testkit.git
17+
```
18+
19+
2. Run test suites using:
20+
```bash
21+
./Runner/run-test.sh
22+
```
23+
24+
3. Ensure `init_env` and utilities are sourced using relative paths:
25+
```bash
26+
. "$(dirname "$0")/../../init_env"
27+
. "$(dirname "$0")/../../utils/functestlib.sh"
28+
```
29+
30+
## Style Guidelines
31+
32+
- Shell scripts must be POSIX-compliant (`#!/bin/sh`)
33+
- Avoid Bash-specific syntax
34+
- Validate using `shellcheck -x`
35+
- Use consistent format: colored output, logging, `PASS/FAIL` status
36+
37+
## Commit and PR Guidelines
38+
39+
- One logical change per commit
40+
- Always add sign-off:
41+
```bash
42+
git commit -s -m "Add test for Bluetooth functionality"
43+
```
44+
45+
- Mention reviewers if needed and explain validation steps
46+
- PRs should be raised against `main` unless otherwise noted
47+
48+
## License
49+
50+
All contributions must include:
51+
```sh
52+
# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
53+
# SPDX-License-Identifier: BSD-3-Clause-Clear
54+
```
55+
56+
## Questions?
57+
58+
Open an issue or start a discussion under the GitHub Issues tab.

README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,6 @@ Sample integration flow:
9191

9292
---
9393

94-
Contributions
95-
96-
Contributions to add more validations, improve robustness, or extend for more platforms are welcome!
97-
98-
Please make sure to sign your commits:
99-
```
100-
git commit -s -m "your commit message"
101-
```
102-
10394
Maintainers
10495

10596
Qualcomm - Initial framework

0 commit comments

Comments
 (0)