devcpune / kaleidoscope Goto Github PK

Add guidelines for contributing to kaleidoscope which includes:

• Steps to add a project by opening a PR.
• Guidelines to open an issue.

If the repo code section starts having projects more than what the screen can hold in the view point then the readme would get hidden!
So maybe having a folder named "project" and adding/moving all the projects/contributions to that folder would help!

The advantages of contributing section is currently empty, add key advantages.

I'm not very familiar with what are the things needed while sharing a Facebook Spark AR Project. If anyone who has worked with this. Kindly share your thought, even better raise a PR updating the CONTRIBUTING.md.

Content Reports allow contributors to the repo to report abuse in the repository to the maintainers. Enabling them by following the outlined steps will allow DevC Pune to maintain a safer environment similar to the Facebook group.

More information related to this can be found here. These steps should be performed by the repository Admin.

Having a specific CODE_OF_CONDUCT.md file will allow GitHub to mention it at various places, ensuring people have more chances to be familiar with it.

Example of how GitHub takes benefit of the file:

Since, according to CONTRIBUTING.md, we are following Facebook's Code of Conduct, the same line repeated in the CODE_OF_CONDUCT.md file should be enough.

## Code of Conduct

Please refer to the **[Code of Conduct](https://engineering.fb.com/codeofconduct/)** adopted by Facebook to understand what kind of behaviour will and not be tolerated when contributing to this project

This can either be a Community default file as indicated by steps here, OR a repo specific file by adding it to docs/CODE_OF_CONDUCT.md alongside the CONTRIBUTING.md file.