Skip to content

Commit 52c36fd

Browse files
ChristopheFerreboeufChristopheFerreboeuf
committed
better doc - issue template
1 parent 1dd82e5 commit 52c36fd

14 files changed

Lines changed: 268 additions & 29 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Bug report
2+
description: Use this template to report a bug in EasyAudit CLI.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
- needs-triage
7+
assignees:
8+
- crealoz-team
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thank you for reporting a bug! Please fill out the details below to help us address the issue.
14+
- type: input
15+
id: bug_description
16+
attributes:
17+
label: Bug Description
18+
description: Provide a clear and concise description of the problem.
19+
placeholder: "Describe the bug in detail..."
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: reproduction_steps
24+
attributes:
25+
label: Steps to Reproduce
26+
description: Provide the steps to reproduce the bug.
27+
placeholder: |
28+
1. Run command '...'
29+
2. With options '...'
30+
3. See the error
31+
validations:
32+
required: true
33+
- type: input
34+
id: expected_behavior
35+
attributes:
36+
label: Expected Behavior
37+
description: Describe what you expected to happen.
38+
placeholder: "The CLI should..."
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: actual_behavior
43+
attributes:
44+
label: Actual Behavior
45+
description: Describe what actually happened.
46+
placeholder: "The CLI currently..."
47+
validations:
48+
required: true
49+
- type: input
50+
id: environment
51+
attributes:
52+
label: Environment Details
53+
description: Include any relevant environment details (e.g., OS, PHP version, installation method).
54+
placeholder: "PHP 8.1, Ubuntu 22.04, Docker/PHAR/source..."
55+
validations:
56+
required: true
57+
- type: dropdown
58+
id: priority
59+
attributes:
60+
label: Priority Level
61+
description: How urgent is this issue?
62+
options:
63+
- Low
64+
- Medium
65+
- High
66+
default: 0
67+
validations:
68+
required: true
69+
- type: textarea
70+
id: additional_context
71+
attributes:
72+
label: Additional Context
73+
description: Add any other information about the problem here.
74+
placeholder: "Screenshots, logs, command output, etc."

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://github.com/crealoz/easyaudit-cli#readme
5+
about: Check the documentation before opening an issue.
6+
- name: Discussions
7+
url: https://github.com/crealoz/easyaudit-cli/discussions
8+
about: Ask questions and share ideas with the community.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature request
2+
description: Use this template to request a new feature for EasyAudit CLI.
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
- needs-triage
7+
assignees:
8+
- crealoz-team
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thank you for suggesting a new feature! Please fill out the details below to help us understand your request.
14+
- type: input
15+
id: feature_description
16+
attributes:
17+
label: Feature Description
18+
description: Provide a clear and concise description of the feature you would like to see.
19+
placeholder: "Describe the feature in detail..."
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: use_case
24+
attributes:
25+
label: Use Case
26+
description: Describe the use case for this feature.
27+
placeholder: "Explain how this feature will be used..."
28+
validations:
29+
required: true
30+
- type: input
31+
id: benefits
32+
attributes:
33+
label: Benefits
34+
description: Describe the benefits of this feature.
35+
placeholder: "This feature will help by..."
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: additional_context
40+
attributes:
41+
label: Additional Context
42+
description: Add any other information about the feature request here.
43+
placeholder: "Screenshots, related issues, etc."

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Description
2+
3+
Thank you for your contribution to the project. Please provide a description of the changes you made.
4+
5+
- [ ] Bug fix
6+
- [ ] New feature
7+
8+
***Describe the changes you made.***
9+
10+
***Please include a reference to the issue you are addressing (if any).***
11+
12+
***
13+
# Testing
14+
15+
- [ ] I have tested the changes locally.

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "composer"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
8+
- package-ecosystem: "github-actions"
9+
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
10+
directory: "/"
11+
schedule:
12+
interval: "weekly"

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
7878
- [CLI Usage](docs/cli-usage.md) - Commands, options, examples
7979
- [Available Processors](docs/processors.md) - All 16 analysis rules
80-
- [GitHub Actions](docs/github-actions.md) - CI/CD workflow examples
80+
- [CI/CD Integration](docs/ci-cd.md) - GitHub, GitLab, Bitbucket, Azure, CircleCI, Jenkins, Travis
8181
- [Automated PR (paid)](docs/request-pr.md) - Auto-fix via API
8282
8383
## Testing

‎docs/ci-cd.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# CI/CD Integration
2+
3+
EasyAudit integrates with all major CI/CD platforms for automated code scanning. Results can be viewed as artifacts or integrated with platform-specific security dashboards.
4+
5+
---
6+
7+
## Supported Platforms
8+
9+
| Platform | Config File | Documentation |
10+
|----------|-------------|---------------|
11+
| GitHub Actions | `.github/workflows/*.yml` | [github-actions.md](ci-cd/github-actions.md) |
12+
| GitLab CI | `.gitlab-ci.yml` | [gitlab-ci.md](ci-cd/gitlab-ci.md) |
13+
| Bitbucket Pipelines | `bitbucket-pipelines.yml` | [bitbucket-pipelines.md](ci-cd/bitbucket-pipelines.md) |
14+
| Azure DevOps | `azure-pipelines.yml` | [azure-devops.md](ci-cd/azure-devops.md) |
15+
| CircleCI | `.circleci/config.yml` | [circleci.md](ci-cd/circleci.md) |
16+
| Jenkins | `Jenkinsfile` | [jenkins.md](ci-cd/jenkins.md) |
17+
| Travis CI | `.travis.yml` | [travis-ci.md](ci-cd/travis-ci.md) |
18+
19+
---
20+
21+
## Quick Example (GitHub Actions)
22+
23+
```yaml
24+
name: EasyAudit
25+
26+
on: [push, pull_request]
27+
28+
jobs:
29+
scan:
30+
runs-on: ubuntu-latest
31+
container:
32+
image: ghcr.io/crealoz/easyaudit:latest
33+
steps:
34+
- uses: actions/checkout@v4
35+
- run: easyaudit scan --format=sarif --output=report.sarif .
36+
- uses: github/codeql-action/upload-sarif@v3
37+
with:
38+
sarif_file: report.sarif
39+
```
40+
41+
---
42+
43+
## Output Formats
44+
45+
| Format | Use Case |
46+
|--------|----------|
47+
| `sarif` | GitHub Code Scanning, GitLab SAST |
48+
| `json` | Custom tooling, artifacts |
49+
| `text` | Console output, logs |
50+
51+
---
52+
53+
## Exit Codes
54+
55+
| Code | Meaning |
56+
|------|---------|
57+
| 0 | No issues found |
58+
| 1 | Warnings found |
59+
| 2 | Errors found |
60+
61+
Use exit codes to fail builds on critical issues.
62+
63+
---
64+
65+
## Auto-Detection
66+
67+
EasyAudit automatically detects CI environments and adds metadata to API requests. Supported detection:
68+
69+
- `GITHUB_ACTIONS` → GitHub
70+
- `GITLAB_CI` → GitLab
71+
- `BITBUCKET_PIPELINE_UUID` → Bitbucket
72+
- `TF_BUILD` → Azure DevOps
73+
- `CIRCLECI` → CircleCI
74+
- `JENKINS_URL` → Jenkins
75+
- `TRAVIS` → Travis CI
76+
77+
---
78+
79+
## See Also
80+
81+
- [CLI Usage](cli-usage.md) - Command-line options
82+
- [Processors](processors.md) - Available checks
83+
- [Automated PR (paid)](request-pr.md) - Auto-fix via API
84+
85+
---
86+
87+
[Back to README](../README.md)

docs/azure-devops.md renamed to docs/ci-cd/azure-devops.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,10 @@ steps:
202202

203203
## See Also
204204

205-
- [Automated PR (paid)](request-pr.md) - Auto-fix issues via API
206-
- [CLI Usage](cli-usage.md) - Local usage
207-
- [Processors](processors.md) - Available checks
205+
- [Automated PR (paid)](../request-pr.md) - Auto-fix issues via API
206+
- [CLI Usage](../cli-usage.md) - Local usage
207+
- [Processors](../processors.md) - Available checks
208208

209209
---
210210

211-
[Back to README](../README.md)
211+
[Back to README](../../README.md)

docs/bitbucket-pipelines.md renamed to docs/ci-cd/bitbucket-pipelines.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,10 @@ pipelines:
153153

154154
## See Also
155155

156-
- [Automated PR (paid)](request-pr.md) - Auto-fix issues via API
157-
- [CLI Usage](cli-usage.md) - Local usage
158-
- [Processors](processors.md) - Available checks
156+
- [Automated PR (paid)](../request-pr.md) - Auto-fix issues via API
157+
- [CLI Usage](../cli-usage.md) - Local usage
158+
- [Processors](../processors.md) - Available checks
159159

160160
---
161161

162-
[Back to README](../README.md)
162+
[Back to README](../../README.md)

docs/circleci.md renamed to docs/ci-cd/circleci.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,10 +203,10 @@ Set `EASYAUDIT_AUTH` in CircleCI:
203203

204204
## See Also
205205

206-
- [Automated PR (paid)](request-pr.md) - Auto-fix issues via API
207-
- [CLI Usage](cli-usage.md) - Local usage
208-
- [Processors](processors.md) - Available checks
206+
- [Automated PR (paid)](../request-pr.md) - Auto-fix issues via API
207+
- [CLI Usage](../cli-usage.md) - Local usage
208+
- [Processors](../processors.md) - Available checks
209209

210210
---
211211

212-
[Back to README](../README.md)
212+
[Back to README](../../README.md)

0 commit comments

Comments
 (0)