Skip to content

Commit 7359d94

Browse files
Documentation updates (#1)
* Rename Docker container to `factif-vnc` in README. Updated the README to use a more concise name for the Docker container. This ensures consistency and clarity for users following the setup instructions. * Add PR template to standardize contributions Introduce a pull request template to ensure consistency in PR descriptions and streamline the review process. The template includes sections for description, types of changes, pre-flight checks, and additional notes. * Add bug report issue template Introduce a standardized bug report template to streamline issue submissions. The template captures key details such as API provider, model used, reproduction steps, and logs to facilitate efficient debugging. This improvement ensures better-structured bug reports and faster resolution of issues. * Disable blank issues and add custom contact links Blank issue creation has been disabled to streamline contributions. A custom link for feature requests directs users to the appropriate discussion category, encouraging organized and focused feedback.
1 parent ce7b00b commit 7359d94

File tree

4 files changed

+87
-1
lines changed

4 files changed

+87
-1
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: ["bug"]
4+
body:
5+
- type: dropdown
6+
id: provider
7+
attributes:
8+
label: Which API Provider are you using?
9+
multiple: false
10+
options:
11+
- Anthropic
12+
- Google Gemini
13+
- AWS Bedrock
14+
- OpenAI
15+
validations:
16+
required: true
17+
- type: input
18+
id: model
19+
attributes:
20+
label: Which Model are you using?
21+
description: Please specify the model you're using (e.g. Claude 3.5 Sonnet)
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: what-happened
26+
attributes:
27+
label: What happened?
28+
description: Also tell us, what did you expect to happen?
29+
placeholder: Tell us what you see!
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: steps
34+
attributes:
35+
label: Steps to reproduce
36+
description: How do you trigger this bug? Please walk us through it step by step.
37+
value: |
38+
1.
39+
2.
40+
3.
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: logs
45+
attributes:
46+
label: Relevant API REQUEST output
47+
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for backticks.
48+
render: shell
49+
- type: textarea
50+
id: additional-context
51+
attributes:
52+
label: Additional context
53+
description: Add any other context about the problem here, such as screenshots or related issues.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Feature Request
4+
url: https://github.com/presidio-oss/factif-ai/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop
5+
about: Share and vote on feature requests for FactifAI

.github/pull_request_template.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
### Description
2+
3+
<!-- Describe your changes in detail. What problem does this PR solve? -->
4+
5+
### Type of Change
6+
7+
<!-- Put an 'x' in all boxes that apply -->
8+
9+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
10+
- [ ] ✨ New feature (non-breaking change which adds functionality)
11+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] 📚 Documentation update
13+
14+
### Pre-flight Checklist
15+
16+
<!-- Put an 'x' in all boxes that apply -->
17+
18+
- [ ] Changes are limited to a single feature, bugfix or chore (split larger changes into separate PRs)
19+
- [ ] Tests are passing (`npm test`) and code is formatted and linted (`npm run format && npm run lint`)
20+
- [ ] I have reviewed [contributor guidelines](https://github.com/presidio-oss/factif-ai/blob/main/CONTRIBUTING.md)
21+
22+
### Screenshots
23+
24+
<!-- For UI changes, add screenshots here -->
25+
26+
### Additional Notes
27+
28+
<!-- Add any additional notes for reviewers -->

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ For comprehensive testing of desktop and mobile applications:
111111
```bash
112112
# Start the VNC environment
113113
docker run -d \
114-
--name factif-ubuntu-vnc \
114+
--name factif-vnc \
115115
-p 5900:5900 \
116116
-p 6080:6080 \
117117
factif-ubuntu-vnc

0 commit comments

Comments
 (0)