You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.rst
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,12 @@ Contribution Ideas
11
11
*********************
12
12
13
13
If you don't know what you want to contribute yet you should take a look at our :resource:`issues page <issues>`.
14
-
See what other people have been up to and if you have an idea for a new feature or a new way to implement a feature you should :resource:`create an issue <issues>` or :resource:`fork the repository <repo>` and start contributing.
14
+
Some other places to start with are:
15
+
16
+
- **Writing and Rewriting Documentation**---as more code changes happen and this library continues to mature, more features get added which need documenting.
17
+
- **Adding examples**---
18
+
19
+
See what other people have been up to all across the home assistant community and if you have an idea for a new feature you should :resource:`create an issue <issues>` or :resource:`fork the repository <repo>` and start contributing.
15
20
We're always interested in integrating ways to make the library faster, extensible and easier to use.
16
21
17
22
Setting up your Development Environment
@@ -22,7 +27,7 @@ So now that you know what you want to contribute it is time to setup a developme
22
27
Step One: Fork the Repository
23
28
===============================
24
29
25
-
Click `here <https://github.com/GrandMoff100/HomeAssistantAPI/fork>`__ to fork the repository.
30
+
Click :resource:`here <fork>` to fork the repository.
26
31
Then click your username.
27
32
28
33
Step Two: Clone the Repository Locally
@@ -95,20 +100,19 @@ If you add a new test that makes real HTTP or WebSocket requests, you need to re
95
100
Code Styling Guidelines
96
101
**************************
97
102
98
-
In order to make sure that our code is easy to read, and navigate.
99
-
As well as to stop stupid mistakes like typos, undefined variables, etc.
100
-
We enforce code standards.
103
+
In order to make sure that our code is easy to read, and navigate
104
+
as well as to stop stupid mistakes like typos, undefined variables, etc,
105
+
we enforce code standards.
101
106
Using the tools, :code:`ruff`, :code:`zuban`, and :code:`pytest`, we make sure that our code quality is top notch and that changes work everywhere.
102
107
You can those tools manually yourself, but they also run automatically when you open a PR.
103
108
104
109
Merging Your Contributions
105
110
*****************************
106
111
107
112
Once you have tested your changes and committed them to your fork you can merge them back into the :resource:`original repository <repo>`.
108
-
Head over to the :resource:`Pull Request Page <new_pr>` and select your fork to merge into the `GrandMoff100/dev` branch.
113
+
Head over to the :resource:`Pull Request Page <new_pr>` and select your fork to merge into the main branch.
109
114
Then you can hit "Create Pull Request" and we'll review it as soon as possible.
110
-
In order to be merged though, your code needs to follow our :ref:`Styling Guidelines <styling>`.
111
-
A Github Actions workflow will run on your PR automatically to verify that it does follow the guidelines.
112
-
Then once the checks have passed one of our maintainers will review the changes (basically to make sure your changes won't break anything ;)).
115
+
In order to be merged, a Github Actions workflow will run on your PR automatically, to check that your code passes the styling checks and tests.
116
+
Then once the checks have passed, one of our maintainers will review the changes and ask for clarification or changes (if needed).
113
117
Then after that your changes will get merged and will be available in the next release!
0 commit comments