Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.96 KB

Contribution Guidelines

Please ensure your pull request adheres to the following:

  • Search previous suggestions before making a new one to ensure yours is not a duplicate.
  • Make an individual pull request for each suggestion.
  • Use the following format: [NAME](LINK) - DESCRIPTION.
  • Keep descriptions simple.
  • New categories, or improvements to the existing ones are welcome.
  • End all descriptions with a period.
  • Make sure your text editor is set to remove trailing whitespace.
  • Try to ensure your pull requests only have one commit if possible. You can squash your commits into one before submitting.
  • Make your pull request titles and descriptions as detailed as possible. Explain why an asset or resources deserves to be added to the list.
  • Ensure that assets you submit are of high quality, documented well, and are recently maintained. It also helps if they're popular so I can research them before adding them to the list.
  • This is not meant to be used as a list to advertise your own assets. Free or open-source assets should be prioritized over paid assets if they are of similar quality and feature sets.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Contributing with Video Tutorial Series

If you are contributing with a series of videos, make sure that you are linking to a Spark AR specific playlist and not a full channel as channels might contain other unrelevant subjects. If the series are covering a specific subject (such as a series on SDFs) within Spark AR it is more likely to be an awesome resoruce.

Contributing with a Script or Example Project.

If you are contributing with a example project, please make sure to host it on a open platform such as GitHub. If it's in a drive or dropbox folder it is harder to find and has a bigger chance of it beeing removed / not preserved.

Thanks!