Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

97 lines (62 loc) · 5.23 KB
Raw

Contributing to SCNNodeVisualDebugger

👍 First of all, big thanks for your desire to contribute in this project 👍

How to contribute

The easiest way to contribute is to report a bug or propose a new feature using GitHub Issues. Also, feel free to send your suggestions concerning any library issues, documentation and README typos, SceneKitSample/ARKitSample improvements, or any other enhancements. We really appreciate your participation!

How to ask a question

Before asking a question, please look through the README and Sample application or take a look into already asked GitHub Issues (even closed). If you still haven't found an answer, feel free to open an issue and ask us your question and mark it with the prepared question label.

How to report a bug

The standard way to report a bug is GitHub Issues.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps to reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate these steps. Include links to files or GitHub projects, or copy/paste snippets. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following these steps and point out what exactly is the problem with that behavior.
  • Explain the behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • If you're reporting a library crash, include a crash report with a stack trace.

Include details about your configuration and environment:

  • Which version of SCNNodeVisualDebugger are you using?
  • Do you test on the Simulator or a Real device?
  • iOS version that you test with.
  • Xcode version if it could be helpful in your case.

How to request an enhancement

Enhancements are features that you might like to suggest to a project, but aren't necessarily bugs/problems with the existing code. There is a label for enhancements in Github's Issues, so you can tag issues as enhancement, and thereby allow us to prioritize issues/bugs reported to the project.

How to tell us about your application

If you are using SCNNodeVisualDebugger in your project that is successfully published to AppStore, send the link to us and we'll add you to the list of applications that use the library.

How to submit changes

When contributing to this repository, please, first discuss the change you wish to make via issue. The preferred workflow for contributing to SCNNodeVisualDebugger is to fork the main repository on GitHub, clone, and develop on a branch.

Steps:

  1. Fork the project repository by clicking on the 'Fork' button near the top right of the page. This creates a copy of the code under your GitHub user account. For more details on how to fork a repository see this guide.

  2. Clone your fork of the SCNNodeVisualDebugger repo from your GitHub account to your local disk

    $ git clone git@github.com:YourLogin/SCNNodeVisualDebugger.git
$ cd SCNNodeVisualDebugger

  3. Checkout to develop branch, and create a feature branch to hold your development changes

    $ git checkout develop
$ git checkout -b feature/my_updates

    Always use a feature branch. It's good practice to add updates to the main branches.

  4. Develop the feature on your feature branch. Add changed files using git add and then git commit files

    $ git add modified_files
$ git commit

    to record your changes in Git, then push the changes to your GitHub account with

    $ git push -u origin feature/my_updates

  5. Add your updates to SceneKitSample/ARKitSample as well. Also, don't forget to update README and CHANGELOG with your changes.

  6. Follow these instructions to create a pull request from your fork. This will send an email to the committers.

(If any of the above seems like magic to you, please look up the Git documentation on the web, or ask a friend or another contributor for help)

Code of Conduct

This project is governed by the CODE OF CONDUCT. By participating, you are expected to uphold this code. Please, report unacceptable behavior to mobile@handsome.is.