Skip to content

Commit b4c9b4a

Browse files
committed
Add obs-ptz documentation files
Brings in all the documentation for obs-ptz. The README file is replaced, but because the build instructions are included in the template's readme, that file is moved into the doc/ directory and referenced by the main README. Signed-off-by: Grant Likely <grant.likely@secretlab.ca>
1 parent ed41789 commit b4c9b4a

13 files changed

+925
-38
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
!CMakePresets.json
1616
!LICENSE
1717
!README.md
18+
!*.md
1819

1920
# Exclude lock files
2021
*.lock.json

AUTHORS

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Original Author: Grant Likely <grant.likely@secretlab.ca>
2+
3+
Contributions are sorted by their number of commits
4+
5+
Contributors:
6+
Grant Likely
7+
Norihiro Kamae
8+
Luuk Verhagen
9+
Jonata Bolzan Loss
10+
Fabio Ferrari
11+
Jim Hauxwell
12+
Eric Schmidt

CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
grant.likely@secretlab.ca.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
Contributing
2+
============
3+
4+
Master copy of this project is hosted on GitHub:
5+
https://github.com/glikely/obs-ptz
6+
7+
Anyone may contribute to this project.
8+
Contributions are licensed under GPLv2 and must be made with a Developer
9+
Certificate of Origin [DCO] "Signed-off-by:" attestation as described below,
10+
indicating that you wrote the code and have the right to pass it on as an open
11+
source patch under the GPLv2 license.
12+
Patches that are not signed off will not be accepted.
13+
14+
Use GitHub pull requests to submit proposed changes.
15+
Or you can email grant.likely@secretlab.ca
16+
17+
Also, please write good git commit messages. A good commit message looks like this:
18+
19+
```
20+
Header line: explain the commit in one line (use the imperative)
21+
22+
Body of commit message is a few lines of text, explaining things
23+
in more detail, possibly giving some background about the issue
24+
being fixed, etc etc.
25+
26+
The body of the commit message can be several paragraphs, and
27+
please do proper word-wrap and keep columns shorter than about
28+
74 characters or so. That way "git log" will show things
29+
nicely even when it's indented.
30+
31+
Make sure you explain your solution and why you're doing what you're
32+
doing, as opposed to describing what you're doing. Reviewers and your
33+
future self can read the patch, but might not understand why a
34+
particular solution was implemented.
35+
36+
Reported-by: whoever-reported-it
37+
Signed-off-by: Your Name <you@example.com>
38+
```
39+
40+
Where that header line really should be meaningful, and really should be just
41+
one line. That header line is what is shown by tools like gitk and shortlog,
42+
and should summarize the change in one readable line of text, independently of
43+
the longer explanation. Please use verbs in the imperative in the commit
44+
message, as in "Fix bug that...", "Add file/feature ...", or "Make plugin ..."
45+
46+
DCO Attestation
47+
---------------
48+
49+
To help track the origin of contributions, this project uses the same
50+
[DCO] "sign-off" process as used by the Linux kernel.
51+
The sign-off is a simple line at the end of the explanation for the
52+
patch, which certifies that you wrote it or otherwise have the right to
53+
pass it on as an open-source patch.
54+
The rules are pretty simple: if you can certify the below:
55+
56+
### Developer's Certificate of Origin 1.1
57+
58+
By making a contribution to this project, I certify that:
59+
60+
(a) The contribution was created in whole or in part by me and I
61+
have the right to submit it under the open source license
62+
indicated in the file; or
63+
64+
(b) The contribution is based upon previous work that, to the best
65+
of my knowledge, is covered under an appropriate open source
66+
license and I have the right under that license to submit that
67+
work with modifications, whether created in whole or in part
68+
by me, under the same open source license (unless I am
69+
permitted to submit under a different license), as indicated
70+
in the file; or
71+
72+
(c) The contribution was provided directly to me by some other
73+
person who certified (a), (b) or (c) and I have not modified
74+
it.
75+
76+
(d) I understand and agree that this project and the contribution
77+
are public and that a record of the contribution (including all
78+
personal information I submit with it, including my sign-off) is
79+
maintained indefinitely and may be redistributed consistent with
80+
this project or the open source license(s) involved.
81+
82+
then you just add a line saying::
83+
84+
Signed-off-by: Random J Developer <random@developer.example.org>
85+
86+
[DCO]: https://developercertificate.org/

0 commit comments

Comments
 (0)