Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refman old #12

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Refman old #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
158ed43
Coding - GH Issue templates #125
dpasukhi Oct 27, 2024
1b65bc8
Documentation - Issue template simplification #127
dpasukhi Oct 28, 2024
802ef8c
Configuration - Second installation failed #129
dpasukhi Oct 28, 2024
2bc4804
Documentation - Build latest refman doc
dpasukhi Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug Report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
name: "Bug Report"
description: "Report a bug related to the OCCT"
labels: ["2. Bug"]
body:
- type: markdown
attributes:
value: |
**Please provide the following information:**
- type: dropdown
attributes:
label: Category
description: "Select the bug category"
options:
- Application Framework
- Build
- Coding
- Configuration
- Data Exchange
- Documentation
- DRAW
- Foundation Classes
- Mesh
- Modeling
- Samples
- Shape Healing
- Testing
- Visualization
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
description: "Select the bug severity"
options:
- Crash
- Critical
- Major
- Minor
- Trivial
default: 2
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: "A detailed description of the bug"
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: "What you expected to happen"
validations:
required: true
- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: "What actually happened"
validations:
required: true
- type: textarea
id: sample_code
attributes:
label: Sample Code or DRAW Tcl Script
description: "Provide a C++ sample or DRAW Tcl script to reproduce the issue"
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: "Select the operating system"
options:
- Linux
- Windows
- macOS
default: 0
validations:
required: true
- type: dropdown
id: compiler
attributes:
label: Compiler
description: "Select the compiler"
options:
- GCC
- Clang
- MSVC
default: 0
validations:
required: true
- type: input
id: compiler_version
attributes:
label: Compiler Version
description: "Specify the compiler version (optional)"
- type: dropdown
id: bitness
attributes:
label: Bitness
description: "Select the bitness"
options:
- 32-bit
- 64-bit
default: 1
validations:
required: true
- type: dropdown
id: occt_version
attributes:
label: OCCT Version
description: "Select the OCCT version where the issue was detected"
options:
- 7.4
- 7.5
- 7.6
- 7.7
- 7.8
- 7.9
- latest
default: 6
validations:
required: true
- type: input
id: precise_occt_version
attributes:
label: Precise OCCT Version or Branch
description: "Specify the precise OCCT version, branch, or SSH (optional)"
- type: input
id: environment
attributes:
label: Environment
description: "Details about your environment (OS, compiler, etc.)"
Comment on lines +134 to +137
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove redundant environment field.

This field asks for OS and compiler information which is already collected through dedicated dropdown fields above. Consider either:

  1. Removing this redundant field, or
  2. Renaming it to "Additional Environment Details" for capturing information not covered by other fields
-      label: Environment
-      description: "Details about your environment (OS, compiler, etc.)"
+      label: Additional Environment Details
+      description: "Any additional environment details not covered by the fields above"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: environment
attributes:
label: Environment
description: "Details about your environment (OS, compiler, etc.)"
id: environment
attributes:
label: Additional Environment Details
description: "Any additional environment details not covered by the fields above"

- type: textarea
id: additional_files
attributes:
label: Additional Files
description: "Attach any additional files that may help in reproducing the issue"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add newline at end of file.

Add a newline character at the end of the file to comply with YAML best practices.

       label: Additional Files
-      description: "Attach any additional files that may help in reproducing the issue"
+      description: "Attach any additional files that may help in reproducing the issue"
+
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
description: "Attach any additional files that may help in reproducing the issue"
description: "Attach any additional files that may help in reproducing the issue"
🧰 Tools
🪛 yamllint

[error] 142-142: no new line character at the end of file

(new-line-at-end-of-file)

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature Request.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "Feature Request"
description: "Request a new feature or enhancement for the OCCT"
labels: ["2. Enhancement"]
body:
- type: markdown
attributes:
value: |
**Please provide the following information:**
- type: dropdown
attributes:
label: Category
description: "Select the bug category"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix incorrect description in category dropdown.

The description refers to "bug category" which is inconsistent with this being a feature request template.

-      description: "Select the bug category"
+      description: "Select the feature category"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
description: "Select the bug category"
description: "Select the feature category"

options:
- Application Framework
- Build
- Coding
- Configuration
- Data Exchange
- Documentation
- DRAW
- Foundation Classes
- Mesh
- Modeling
- Samples
- Shape Healing
- Testing
- Visualization
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: "A detailed description of the feature request"
validations:
required: true
- type: textarea
id: use_case
attributes:
label: Use Case
description: "Describe the use case for the feature"
validations:
required: true
- type: textarea
id: benefits
attributes:
label: Benefits
description: "Explain the benefits of the feature"
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: "Any additional context or information"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add newline at end of file.

Following YAML best practices, files should end with a newline character.

       description: "Any additional context or information"
+
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
description: "Any additional context or information"
description: "Any additional context or information"
🧰 Tools
🪛 yamllint

[error] 55-55: no new line character at the end of file

(new-line-at-end-of-file)

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Collaborative development portal
url: https://dev.opencascade.org/forums
about: You can also use the collaborative development portal to ask questions and discuss the problem you are seeing
- name: GitHub discussions
url: https://github.com/Open-Cascade-SAS/OCCT/discussions
about: You can also use GitHub discussions to ask questions and discuss the problem you are seeing
- name: Mantis bug tracker
url: https://tracker.dev.opencascade.org/
about: You can also use the Mantis bug tracker to report bugs and issues
- name: Contact US form
url: https://dev.opencascade.org/webform/contact_us
about: You can also use the Contact US form to ask questions and discuss the problem you are seeing
Comment on lines +3 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve contact link descriptions

The current descriptions are very similar and don't clearly differentiate when to use each channel. Consider making each description more specific:

   - name: Collaborative development portal
     url: https://dev.opencascade.org/forums
-    about: You can also use the collaborative development portal to ask questions and discuss the problem you are seeing
+    about: Best for technical discussions and getting help from the community
   - name: GitHub discussions
     url: https://github.com/Open-Cascade-SAS/OCCT/discussions
-    about: You can also use GitHub discussions to ask questions and discuss the problem you are seeing
+    about: For feature ideas, best practices, and general Q&A
   - name: Mantis bug tracker
     url: https://tracker.dev.opencascade.org/
-    about: You can also use the Mantis bug tracker to report bugs and issues
+    about: For reporting bugs that don't require immediate attention
   - name: Contact Us form
     url: https://dev.opencascade.org/webform/contact_us
-    about: You can also use the Contact US form to ask questions and discuss the problem you are seeing
+    about: For commercial inquiries and private support requests
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Collaborative development portal
url: https://dev.opencascade.org/forums
about: You can also use the collaborative development portal to ask questions and discuss the problem you are seeing
- name: GitHub discussions
url: https://github.com/Open-Cascade-SAS/OCCT/discussions
about: You can also use GitHub discussions to ask questions and discuss the problem you are seeing
- name: Mantis bug tracker
url: https://tracker.dev.opencascade.org/
about: You can also use the Mantis bug tracker to report bugs and issues
- name: Contact US form
url: https://dev.opencascade.org/webform/contact_us
about: You can also use the Contact US form to ask questions and discuss the problem you are seeing
- name: Collaborative development portal
url: https://dev.opencascade.org/forums
about: Best for technical discussions and getting help from the community
- name: GitHub discussions
url: https://github.com/Open-Cascade-SAS/OCCT/discussions
about: For feature ideas, best practices, and general Q&A
- name: Mantis bug tracker
url: https://tracker.dev.opencascade.org/
about: For reporting bugs that don't require immediate attention
- name: Contact Us form
url: https://dev.opencascade.org/webform/contact_us
about: For commercial inquiries and private support requests

5 changes: 4 additions & 1 deletion .github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ on:
push:
branches:
- 'master'
pull_request:
branches:
- '**'
Comment on lines +11 to +13
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Consider restricting PR trigger branches

While adding PR triggers is beneficial for validation, using '**' will run the workflow on all branches, including temporary feature branches. This could lead to unnecessary builds and consume GitHub Actions minutes.

Consider limiting the branches to those that are likely to contain documentation changes:

  pull_request:
    branches:
-      - '**'
+      - 'master'
+      - 'develop'
+      - 'docs/**'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
pull_request:
branches:
- '**'
pull_request:
branches:
- 'master'
- 'develop'
- 'docs/**'


jobs:
build:
name: Build Refman Documentation
runs-on: ubuntu-24.04
runs-on: ubuntu-20.04

steps:
# Step: Checkout the repository
Expand Down
5 changes: 3 additions & 2 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,9 +1036,10 @@ endif()
# validating custom.bat/sh for changes
if (EXISTS "${CMAKE_BINARY_DIR}/custom.${SCRIPT_EXT}" AND EXISTS "${INSTALL_DIR}/${INSTALL_DIR_SCRIPT}/custom.${SCRIPT_EXT}")
file (READ "${INSTALL_DIR}/${INSTALL_DIR_SCRIPT}/custom.${SCRIPT_EXT}" CUSTOM_CONTENT)
if (NOT "${CUSTOM_CONTENT}" MATCHES "${ADDITIONAL_CUSTOM_CONTENT}")
string(FIND "${CUSTOM_CONTENT}" "${ADDITIONAL_CUSTOM_CONTENT}" pos)
if (pos EQUAL -1)
set (CUSTOM_CONTENT "${CUSTOM_CONTENT} ${ADDITIONAL_CUSTOM_CONTENT}")
OCCT_CONFIGURE_AND_INSTALL ("adm/templates/custom.${SCRIPT_EXT}.main" "custom.${SCRIPT_EXT}" "custom.${SCRIPT_EXT}" "${CUSTOM_CONTENT}")
OCCT_CONFIGURE_AND_INSTALL ("adm/templates/custom.${SCRIPT_EXT}.main" "custom.${SCRIPT_EXT}" "custom.${SCRIPT_EXT}" "${INSTALL_DIR_SCRIPT}")
endif()
else()
OCCT_CONFIGURE_AND_INSTALL ("adm/templates/custom.${SCRIPT_EXT}.main" "custom.${SCRIPT_EXT}" "custom.${SCRIPT_EXT}" "${INSTALL_DIR_SCRIPT}")
Expand Down
Loading