Skip to content

Latest commit

 

History

History
124 lines (93 loc) · 7.45 KB

CONTRIBUTING.md

File metadata and controls

124 lines (93 loc) · 7.45 KB
Raw

Contributing

What should I know before I get started?

Please read about the project on the main page of this repository.

How to contribute to this project

We would love to know if you find errors to this project. If you do, create an issue.

Creating an issue

Creating an issue for errors is an important way you can contribute to the IKEA3DAssemblyDataset. This section guides you through submitting an issue report regarding the IKEA3DAssemblyDataset. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. When creating an issue, you will be asked to select and follow one of the repository issues templates, depending on the matter of the issue you want to report.

Before creating an issue, please check that an issue reporting the same problem does not already exist. If there is such an open issue, you may add your information as a comment.

When creating an issue, please include

  1. The name of the file that contains the error.
  2. Description of the error/fix.
  3. Screenshot where you have marked the area that needs to be fixed. This is especially important when you found an error on a 3D or 2D file.

When you are creating an issue, please include as many details as possible. Issues are tracked as GitHub issues.

Pull requests

We are not accepting pull requests for changed 3D models. The reason is that IKEA need to update the source 3D files at IKEA and generate a new version which is exported either to .glTF or .obj format to add to the repo. Pull requests to change or add 3D models to the repo will only be accepted for review if they are created by the repository maintainers.

Participation Guidelines (Code of Conduct)

IKEA have for this repository adopted the Contributor Covenant and project participants are expected to adhere to it. Please read the Participation Guidelines (Code of Conduct) to understand what actions will and will not be tolerated. Read more about our rules for communication here.

Creating new 3D models [this is information is for IKEA maintainers]

For the .glTF/.glB models

  1. Create new 3D models using 3ds Max 2021
  2. Make sure you always are using mm as a system unit inside 3ds Max
  3. Export the .glTF/.glB models using babylonJs exporter in 3ds Max
  4. Remember to add copyright information to the files

For the .obj models

  1. Create new 3D models using 3ds Max 2021
  2. Make sure you always are using mm as a system unit inside 3ds Max
  3. Export the .obj models using standard 3ds Max
  4. Doublecheck that you exported the model with the correct units
  5. Remember to add copyright information inside the header of the files