Skip to content

Commit 1549dfd

Browse files
committed
Update contributing section
1 parent 9d039a1 commit 1549dfd

3 files changed

Lines changed: 17 additions & 12 deletions

File tree

docs/CONTRIBUTING.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@ Contribution Ideas
1111
*********************
1212

1313
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.
1520
We're always interested in integrating ways to make the library faster, extensible and easier to use.
1621

1722
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
2227
Step One: Fork the Repository
2328
===============================
2429

25-
Click `here <https://github.com/GrandMoff100/HomeAssistantAPI/fork>`__ to fork the repository.
30+
Click :resource:`here <fork>` to fork the repository.
2631
Then click your username.
2732

2833
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
95100
Code Styling Guidelines
96101
**************************
97102

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.
101106
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.
102107
You can those tools manually yourself, but they also run automatically when you open a PR.
103108

104109
Merging Your Contributions
105110
*****************************
106111

107112
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.
109114
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).
113117
Then after that your changes will get merged and will be available in the next release!
114118

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,9 @@
5656
"issues": f"{repo_url}/issues",
5757
"discussions": f"{repo_url}/discussions",
5858
"examples": f"{repo_url}/tree/{branch}/examples",
59-
"new_pr": f"{repo_url}/compare",
59+
"new_pr": f"{repo_url}/pulls",
6060
"pypi": "https://pypi.org/project/homeassistant_api",
61+
"fork": f"{repo_url}/fork",
6162
}
6263

6364
# Add any paths that contain templates here, relative to this directory.

docs/quickstart.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ Then you should be all set to start using the library!
8686
If run into any problems open an issue on our github :resource:`issue tracker <issues>`
8787

8888

89-
Example Usages
90-
================
89+
Example Use Case Ideas
90+
=======================
9191
Some examples applications of this project include integrating it into a another library, web application or a custom automation script.
9292
Maybe you want to start a project that allows you to use your Home Assistant from your command line but with some sassy responses.
9393
Or maybe add it to a discord bot to manage your Home Assistant from inside discord.

0 commit comments

Comments
 (0)