Skip to content

Commit 1d42568

Browse files
committed
update CONTRIBUTING.md
1 parent 2e03a66 commit 1d42568

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,5 @@
11
# Contribution Guidelines
22

3-
The following behaviors are **strictly prohibited** within this repository:
4-
5-
- Any form of abuse, harassment, defamatory, threatening, or discriminatory behavior.
6-
- Use of offensive language or hate speech in any form.
7-
- Discussions on divisive topics such as politics, religion, race, etc.
8-
- Impersonating PTC staff, admins, moderators, or other community members.
9-
- Trolling or posting off-topic content.
10-
- Hijacking or derailing of threads.
11-
- Discussions or promotion of pirated software or illegal activities.
12-
- Requests to create, optimize, or debug code not related to Vuforia Engine.
13-
- Spamming, including the creation of duplicate threads or posts, as well as advertising.
14-
15-
Threads and replies lacking in content or not contributing to the discussion will be removed without warning. All posts are expected to contain meaningful information and contribute to the community constructively. If there's no response, threads are closed within 7-14 days.
16-
17-
**Appeals or commentary on suspension decisions, support requests, suggestions disparaging others, and non-constructive feedback will be closed without comment.**
18-
19-
**Note:** This repository also follows [PTC Community's Community Guidelines](https://community.ptc.com/t5/Welcome-How-To-s/Community-Guidelines/m-p/795342).
20-
213
## Where to contribute
224

235
Please use the [issue tracker](https://github.com/PTCInc/vuforia-engine/issues) to report bugs, share feedback, or request new features and device support. You can use the "New issue" button to choose one of the issue templates. Currently, we provide a few different issue templates:
@@ -26,6 +8,8 @@ Please use the [issue tracker](https://github.com/PTCInc/vuforia-engine/issues)
268
- **Device Feedback:** To share feedback related to new devices, platforms, or scanners.
279
- **Documentation or Samples Feedback:** To share feedback related to our sample code or the Vuforia Library.
2810

11+
**Note:** This repository also follows [PTC Community's Community Guidelines](https://community.ptc.com/t5/Welcome-How-To-s/Community-Guidelines/m-p/795342).
12+
2913
## How to write a bug report
3014

3115
If you’re experiencing a technical issue or a bug, you can submit a case using the "Bug Report" issue template.
@@ -36,6 +20,8 @@ Please submit an issue using the information below to increase your chances of g
3620
- **Developer Platform version** (Unity, Android Studio, Xcode, Visual Studio)
3721
- **Device information** (Model name, OS, version, etc.)
3822

23+
**Note:** PTC staff can only provide developer support for the most recent versions of the Vuforia Engine. Versions 9 or earlier are deprecated and may not receive a response.
24+
3925
When reporting an issue, please clearly describe the problem, including the expected outcome and the steps taken to reproduce it. To help troubleshoot the issue, please reproduce it using the [Core Samples](https://developer.vuforia.com/downloads/samples) of Vuforia Engine, as this will aid in identifying the cause of the issue. Please use our [troubleshooting guide](https://developer.vuforia.com/library/troubleshooting/troubleshooting-your-app) to narrow down plausible causes of your problem.
4026

4127
- **Observed problem**
@@ -44,17 +30,17 @@ When reporting an issue, please clearly describe the problem, including the expe
4430

4531
It is essential to clearly describe the *observed problem* and *expected outcome* when reporting an issue, as this allows for a better understanding of the problem at hand. Additionally, providing *reproducible steps* is crucial, as it allows for the replication of the issue and verification of the solution.
4632

47-
When reporting an issue, it is also essential to provide additional details depending on the nature of the problem, such as error messages, visual glitches, etc:
33+
When reporting an issue, it is also essential to provide additional details depending on the nature of the problem, such as error messages, visual glitches, etc.
34+
35+
These valuable details will help us assess your specific issue better:
4836

4937
- **Device log files**
5038
- **Affected datasets**
5139
- **Videos showing the observed issue** (e.g., visual artifact screen recording, target issue recording, etc.)
5240
- **Session Recording file** (Through the [SessionRecorder API](https://developer.vuforia.com/library/platform-support/recording-and-playback))
5341
- **Other observations and notes**
5442

55-
These valuable details will help us assess your specific issue better. Please use OneDrive to share larger files and projects.
56-
57-
**Note:** PTC staff can only provide developer support for the most recent versions of the Vuforia Engine. Versions 9 or earlier are deprecated and may not receive a response.
43+
Please use OneDrive to share larger files and projects by sharing a link in the issue report. For sensitive data, you can send the OneDrive link to vuforia-feedback@ptc.com with the issue-case number.
5844

5945
## How to share feedback
6046

@@ -69,3 +55,22 @@ Please consider the following information when sharing feedback to increase the
6955
- Share your feedback with others to increase support and improve the chances of implementation.
7056

7157
**Note:** Submitting feedback or requests does not guarantee they will be acted upon. We will make every effort to provide an explanation for why an idea may or may not be feasible, but there may be instances where we are unable to share that kind of information.
58+
59+
## What is disallowed
60+
61+
The following behaviors are **strictly prohibited** within this repository:
62+
63+
- Any form of abuse, harassment, defamatory, threatening, or discriminatory behavior.
64+
- Use of offensive language or hate speech in any form.
65+
- Discussions on divisive topics such as politics, religion, race, etc.
66+
- Impersonating PTC staff, admins, moderators, or other community members.
67+
- Trolling or posting off-topic content.
68+
- Hijacking or derailing of threads.
69+
- Discussions or promotion of pirated software or illegal activities.
70+
- Requests to create, optimize, or debug code not related to Vuforia Engine.
71+
- Spamming, including the creation of duplicate threads or posts, as well as advertising.
72+
73+
Threads and replies lacking in content or not contributing to the discussion will be removed without warning. All posts are expected to contain meaningful information and contribute to the community constructively. If there's no response, threads are closed within 7-14 days.
74+
75+
**Appeals or commentary on suspension decisions, support requests, suggestions disparaging others, and non-constructive feedback will be closed without comment.**
76+

0 commit comments

Comments
 (0)