Click here to see environment details
"
102 | echo " "
103 | print_env | while read -r line; do
104 | echo " $line"
105 | done
106 | echo "
"
107 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/documentation_request_correction.yml:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2 | # SPDX-License-Identifier: Apache-2.0
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # http://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | name: Documentation - Correction/Update Request
17 | description: Request corrections or updates to existing documentation
18 | title: "[DOC]: "
19 | labels: ["doc"]
20 |
21 | body:
22 | - type: markdown
23 | attributes:
24 | value: |
25 | Thanks for taking the time to improve our documentation!
26 |
27 | - type: dropdown
28 | id: criticality
29 | attributes:
30 | label: How would you describe the priority of this documentation request
31 | options:
32 | - Critical (currently preventing usage)
33 | - High
34 | - Medium
35 | - Low (would be nice)
36 | validations:
37 | required: true
38 |
39 | - type: input
40 | id: correction_location
41 | attributes:
42 | label: Please provide a link or source to the relevant docs
43 | placeholder: "ex: https://github.com/NVIDIA/3DObjectReconstruction/blob/main/README.md"
44 | validations:
45 | required: true
46 |
47 | - type: textarea
48 | id: problem
49 | attributes:
50 | label: Describe the problems in the documentation
51 | placeholder: The documents say to use foo.func(args) however an AttributeError is thrown
52 | validations:
53 | required: true
54 |
55 | - type: textarea
56 | id: correction
57 | attributes:
58 | label: (Optional) Propose a correction
59 | placeholder: foo.func() was deprecated, replace documentation with foo.new_func()
60 |
61 | - type: checkboxes
62 | id: terms
63 | attributes:
64 | label: Code of Conduct
65 | description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/3DObjectReconstruction/blob/main/CODE_OF_CONDUCT.md)
66 | options:
67 | - label: I agree to follow 3D Object Reconstruction's Code of Conduct
68 | required: true
69 | - label: I have searched the [open documentation issues](https://github.com/NVIDIA/3DObjectReconstruction/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
70 | required: true
71 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report_form.yml:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2 | # SPDX-License-Identifier: Apache-2.0
3 | #
4 | # Licensed under the Apache License, Version 2.0 (the "License");
5 | # you may not use this file except in compliance with the License.
6 | # You may obtain a copy of the License at
7 | #
8 | # http://www.apache.org/licenses/LICENSE-2.0
9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 |
16 | name: Bug Report
17 | description: File a bug report
18 | title: "[BUG]: "
19 | labels: ["bug"]
20 |
21 | body:
22 | - type: markdown
23 | attributes:
24 | value: |
25 | Thanks for taking the time to fill out this bug report!
26 |
27 | - type: input
28 | id: version
29 | attributes:
30 | label: Version
31 | description: What version of 3D Object Reconstruction are you running?
32 | placeholder: "example: 0.1.0"
33 | validations:
34 | required: true
35 |
36 | - type: dropdown
37 | id: installation-method
38 | attributes:
39 | label: Which installation method(s) does this occur on?
40 | multiple: true
41 | options:
42 | - Docker
43 | - Conda
44 | - Pip
45 | - Source
46 |
47 | - type: textarea
48 | id: description
49 | attributes:
50 | label: Describe the bug.
51 | description: Also tell us, what did you expect to happen?
52 | placeholder: XYZ occured, I expected QRS results
53 | validations:
54 | required: true
55 |
56 | - type: textarea
57 | id: mvr
58 | attributes:
59 | label: Minimum reproducible example
60 | description: Please supply a [minimum reproducible code example](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) here
61 | render: shell
62 |
63 | - type: textarea
64 | id: logs
65 | attributes:
66 | label: Relevant log output
67 | description: Please paste relevant error and log output here
68 | render: shell
69 |
70 | - type: textarea
71 | id: env-printout
72 | attributes:
73 | label: Full env printout
74 | description: Please run and paste the output of the `print_env.sh` script here, to gather any other relevant environment details
75 | render: shell
76 |
77 | - type: textarea
78 | id: misc
79 | attributes:
80 | label: Other/Misc.
81 | description: Please enter any other helpful information here.
82 |
83 | - type: textarea
84 | id: dataset
85 | attributes:
86 | label: Dataset
87 | description: Please provide a public link to the dataset you are using along with the output directory for repro if possible.
88 |
89 | - type: checkboxes
90 | id: terms
91 | attributes:
92 | label: Code of Conduct
93 | description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/3DObjectReconstruction/blob/main/CODE_OF_CONDUCT.md)
94 | options:
95 | - label: I agree to follow 3D Object Reconstruction's Code of Conduct
96 | required: true
97 | - label: I have searched the [open bugs](https://github.com/NVIDIA/3DObjectReconstruction/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this bug report
98 | required: true
99 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to 3D Object Reconstruction
2 |
3 | If you are interested in contributing to 3D Object Reconstruction, your contributions will fall
4 | into three categories:
5 | 1. You want to report a bug, feature request, or documentation issue
6 | - File an [issue](hhttps://github.com/NVIDIA/3DObjectReconstruction/issues/new/choose)
7 | describing what you encountered or what you want to see changed.
8 | - Please run and paste the output of the `3DObjectReconstruction/print_env.sh` script while
9 | reporting a bug to gather and report relevant environment details.
10 | - The 3D Object Reconstruction team will evaluate the issues and triage them, scheduling
11 | them for a release. If you believe the issue needs priority attention
12 | comment on the issue to notify the team.
13 | 2. You want to propose a new Feature and implement it
14 | - Post about your intended feature, and we shall discuss the design and
15 | implementation.
16 | - Once we agree that the plan looks good, go ahead and implement it, using
17 | the [code contributions](#code-contributions) guide below.
18 | 3. You want to implement a feature or bug-fix for an outstanding issue
19 | - Follow the [code contributions](#code-contributions) guide below.
20 | - If you need more context on a particular issue, please ask and we shall
21 | provide.
22 |
23 | ## Code contributions
24 |
25 | ### Your first issue
26 |
27 | 1. Read the project's [README.md](https://github.com/NVIDIA/3DObjectReconstruction/blob/main/README.md)
28 | to learn how to setup the development environment.
29 | 2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/nvidia/3DObjectReconstruction/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
30 | or [help wanted](https://github.com/nvidia/3DObjectReconstruction/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels
31 | 3. Comment on the issue saying you are going to work on it.
32 | 4. Code! Make sure to contribute any unit tests and validate that the workflow works with the default inference example!
33 | 6. When done, [create your pull request](https://github.com/nvidia/3DObjectReconstruction/compare).
34 | 7. Wait for other developers to review your code and update code as needed.
35 | 8. Once reviewed and approved, a 3D Object Reconstruction developer will merge your pull request.
36 |
37 | Remember, if you are unsure about anything, don't hesitate to comment on issues and ask for clarifications!
38 |
39 | ### Managing PR labels
40 |
41 | Each PR must be labeled according to whether it is a "breaking" or "non-breaking" change (using Github labels). This is used to highlight changes that users should know about when upgrading.
42 |
43 | For 3D Object Reconstruction, a "breaking" change is one that modifies the codebase in a
44 | non-backward-compatible way.
45 |
46 | Additional labels must be applied to indicate whether the change is a feature, improvement, bugfix, or documentation change.
47 |
48 | ### Branch naming
49 |
50 | Branches used to create PRs should have a name of the form `