Skip to content

Commit 07b8ea3

Browse files
JelloeaterJelloeater
committed
Updated readme
1 parent 57b5720 commit 07b8ea3

6 files changed

+248
-11
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,4 @@ dmypy.json
133133
!*.secret
134134
dev.env
135135
.env
136+
*.env

‎CODE_OF_CONDUCT.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Code of Conduct - hubitatcontrol
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment for our
15+
community include:
16+
17+
* Demonstrating empathy and kindness toward other people
18+
* Being respectful of differing opinions, viewpoints, and experiences
19+
* Giving and gracefully accepting constructive feedback
20+
* Accepting responsibility and apologizing to those affected by our mistakes,
21+
and learning from the experience
22+
* Focusing on what is best not just for us as individuals, but for the
23+
overall community
24+
25+
Examples of unacceptable behavior include:
26+
27+
* The use of sexualized language or imagery, and sexual attention or
28+
advances
29+
* Trolling, insulting or derogatory comments, and personal or political attacks
30+
* Public or private harassment
31+
* Publishing others' private information, such as a physical or email
32+
address, without their explicit permission
33+
* Other conduct which could reasonably be considered inappropriate in a
34+
professional setting
35+
36+
## Our Responsibilities
37+
38+
Project maintainers are responsible for clarifying and enforcing our standards of
39+
acceptable behavior and will take appropriate and fair corrective action in
40+
response to any instances of unacceptable behavior.
41+
42+
Project maintainers have the right and responsibility to remove, edit, or reject
43+
comments, commits, code, wiki edits, issues, and other contributions that are
44+
not aligned to this Code of Conduct, or to ban
45+
temporarily or permanently any contributor for other behaviors that they deem
46+
inappropriate, threatening, offensive, or harmful.
47+
48+
## Scope
49+
50+
This Code of Conduct applies within all community spaces, and also applies when
51+
an individual is officially representing the community in public spaces.
52+
Examples of representing our community include using an official e-mail address,
53+
posting via an official social media account, or acting as an appointed
54+
representative at an online or offline event.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported to the community leaders responsible for enforcement at <[email protected]>.
60+
All complaints will be reviewed and investigated promptly and fairly.
61+
62+
All community leaders are obligated to respect the privacy and security of the
63+
reporter of any incident.
64+
65+
## Attribution
66+
67+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
68+
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
69+
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
70+
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

‎CONTRIBUTING.md

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
<!-- omit in toc -->
2+
# Contributing to hubitatcontrol
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
<!-- omit in toc -->
15+
## Table of Contents
16+
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Suggesting Enhancements](#suggesting-enhancements)
22+
- [Your First Code Contribution](#your-first-code-contribution)
23+
- [Improving The Documentation](#improving-the-documentation)
24+
- [Styleguides](#styleguides)
25+
- [Commit Messages](#commit-messages)
26+
- [Join The Project Team](#join-the-project-team)
27+
28+
29+
## Code of Conduct
30+
31+
This project and everyone participating in it is governed by the
32+
[hubitatcontrol Code of Conduct](https://github.com/Jelloeater/hubitatcontrolblob/master/CODE_OF_CONDUCT.md).
33+
By participating, you are expected to uphold this code. Please report unacceptable behavior
34+
to <[email protected]>.
35+
36+
37+
## I Have a Question
38+
39+
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/Jelloeater/hubitatcontrol/tree/main/docs).
40+
41+
Before you ask a question, it is best to search for existing [Issues](https://github.com/Jelloeater/hubitatcontrol/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
42+
43+
If you then still feel the need to ask a question and need clarification, we recommend the following:
44+
45+
- Open an [Issue](https://github.com/Jelloeater/hubitatcontrol/issues/new).
46+
- Provide as much context as you can about what you're running into.
47+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
48+
49+
We will then take care of the issue as soon as possible.
50+
51+
<!--
52+
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
53+
54+
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
55+
- IRC
56+
- Slack
57+
- Gitter
58+
- Stack Overflow tag
59+
- Blog
60+
- FAQ
61+
- Roadmap
62+
- E-Mail List
63+
- Forum
64+
-->
65+
66+
## I Want To Contribute
67+
68+
> ### Legal Notice <!-- omit in toc -->
69+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
70+
71+
### Reporting Bugs
72+
73+
<!-- omit in toc -->
74+
#### Before Submitting a Bug Report
75+
76+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
77+
78+
- Make sure that you are using the latest version.
79+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/Jelloeater/hubitatcontrol/tree/main/docs). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Jelloeater/hubitatcontrolissues?q=label%3Abug).
81+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
82+
- Collect information about the bug:
83+
- Stack trace (Traceback)
84+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
85+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
86+
- Possibly your input and the output
87+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
88+
89+
<!-- omit in toc -->
90+
#### How Do I Submit a Good Bug Report?
91+
92+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]>.
93+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
94+
95+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
96+
97+
- Open an [Issue](https://github.com/Jelloeater/hubitatcontrol/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
98+
- Explain the behavior you would expect and the actual behavior.
99+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
100+
- Provide the information you collected in the previous section.
101+
102+
Once it's filed:
103+
104+
- The project team will label the issue accordingly.
105+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
106+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
107+
108+
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
109+
110+
111+
### Suggesting Enhancements
112+
113+
This section guides you through submitting an enhancement suggestion for hubitatcontrol, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
114+
115+
<!-- omit in toc -->
116+
#### Before Submitting an Enhancement
117+
118+
- Make sure that you are using the latest version.
119+
- Read the [documentation](https://github.com/Jelloeater/hubitatcontrol/tree/main/docs) carefully and find out if the functionality is already covered, maybe by an individual configuration.
120+
- Perform a [search](https://github.com/Jelloeater/hubitatcontrol/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
121+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
122+
123+
<!-- omit in toc -->
124+
#### How Do I Submit a Good Enhancement Suggestion?
125+
126+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/Jelloeater/hubitatcontrol/issues).
127+
128+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
129+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
130+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
131+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
132+
- **Explain why this enhancement would be useful** to most hubitatcontrol users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
133+
134+
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
135+
136+
### Your First Code Contribution
137+
<!-- TODO
138+
include Setup of env, IDE and typical getting started instructions?
139+
140+
-->
141+
142+
### Improving The Documentation
143+
<!-- TODO
144+
Updating, improving and correcting the documentation
145+
146+
-->
147+
148+
## Styleguides
149+
### Commit Messages
150+
<!-- TODO
151+
152+
-->
153+
154+
## Join The Project Team
155+
<!-- TODO -->
156+
157+
<!-- omit in toc -->
158+
## Attribution
159+
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

‎README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# porch_light
2+
3+
[![CodeQL](https://github.com/Jelloeater/porch_light/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/Jelloeater/porch_light/actions/workflows/codeql.yml)
4+
[![GitHub](https://img.shields.io/github/license/jelloeater/porch_light)](https://github.com/Jelloeater/porch_light/blob/main/LICENSE)
5+
26
## Setup
37

48
Install Go-Task --> <https://taskfile.dev/installation/>
59

6-
[//]: # (TODO Clean .env files from Git history https://daily-dev-tips.com/posts/removing-a-env-file-from-git-history/)
10+
```shell
11+
task setup
12+
task docker_build_and_run
13+
```
14+
15+
# Testing
716

817
```shell
9-
task setup # Setup
10-
task # Test
11-
task deploy # Deploy
18+
task test
1219
```

‎Taskfile.yaml

+3-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ tasks:
99
default:
1010
- task --list-all
1111
# Local Dev
12-
build:
12+
test:
1313
silent: false
1414
interactive: false
1515
cmds:
1616
- poetry install
1717
- task: commit
18-
- task: test
18+
- task: pytest
1919
commit:
2020
- task: format
2121
- task: security
@@ -36,7 +36,7 @@ tasks:
3636
- poetry run whispers {{.BUILD_DIR}} # Check for security issues
3737
- poetry run bandit --silent -r {{.BUILD_DIR}}
3838
- poetry run tartufo scan-local-repo .
39-
test:
39+
pytest:
4040
silent: false
4141
interactive: false
4242
dotenv: [prod.env]
@@ -63,10 +63,6 @@ tasks:
6363
- poetry run mdformat docs
6464
- git add docs
6565
docker-purge: docker system prune -a -f --volumes
66-
show_secrets:
67-
- git secret reveal -f
68-
save_secrets:
69-
- git secret hide -m -d
7066
start_webserver: poetry run python3 pl_worker/webserver.py
7167
start_docker_rootless:
7268
env: # Due to running root-less on dev box

‎codeowners

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Use this file to define individuals or teams that are responsible for code in a repository.
2+
# Read more: <https://help.github.com/articles/about-codeowners/>
3+
# Order is important: the last matching pattern has the highest precedence
4+
* @jelloeater

0 commit comments

Comments
 (0)