Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

66 lines (39 loc) · 2.29 KB
Raw

Contributing

Guidelines

See below for contribution information.

How can I get involved?

First of all, thank you! I welcome all invitations for a friendly chat, exchange ideas and ask questions.

I've found a typo

  • A Pull Request is not necessary. Raise an Issue and I'll fix it as soon as I can.

I have a [great] idea

I'd like to make this Kiosk project the best it can be and welcome new contributions that align with the project's goals. That being said, if you have a proposal please contemplate its feasibility and timeline and provide a few sentences proposing your awesome idea!

Quick Proposal Summary:

  • A sentence or two summary including motivation/context
  • Any design changes
  • Pros + Cons
  • Effort required
  • Mock-up screenshots or examples of how the CLI would work

Paperwork for Pull Requests

Please read this whole guide and make sure you agree to our DCO agreement (included below):

  • Sign-off your commits
  • Reference addressed issues in the PR description & commit messages - use 'Fixes #IssueNo'
  • Always give instructions for testing
  • Provide CLI commands and output or screenshots where you can (screenshots are awesome!)

I have a question, a suggestion or need help

Please raise an Issue!

Governance

Kiosk is a project based on Potree modified by Cecilia C. Constantine as a proof-of-concept for Vizcaya Museum and Gardens

License

This project is licensed under the MIT License.

Sign your work

Note: all of the commits in your PR/Patch must be signed-off.

The sign-off is a simple line at the end of the explanation for a patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):

Just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

  • Please sign your commits with git commit -s so that commits are traceable.