Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.86 KB

Contributing to scene_synthesizer

Thank you for contributing to scene_synthesizer!

Ways to Contribute

Reporting Bugs

Bugs are tracked as GitHub issues. Create an issue, explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps: a copy/pasteable code snippet.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots if possible.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title.
  • Provide specific examples to demonstrate the steps: a copy/pasteable code snippets.
  • Describe the current behavior and explain which behavior the enchancement will introduce.
  • Explain why this enhancement would be useful.

Pull Requests

  • Link to the issue that your change relates to. If there is not yet an issue for your bug or issue for an enhancement request, please open a new issue and then link to that issue in your pull request.
  • Fix description: short walk-through the concept of the solution.

If it is a bugfix PR:

  • Verify that examples that use the fixed modules are working and their READMEs are updated if that is needed.

If it is an enhancement/feature PR:

  • Provide a new example if major feature or enchancement is introduced.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

For code style etc. see the development guide.