jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-21 08:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update commit message details, move test reference (#562)

Browse Source 
* Update commit message details, move test reference

and add link to main repo

* Update docs/development_submitting.md

Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>

Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>
This commit is contained in:
Lindsay Ward 2020-06-27 07:44:03 +10:00 committed by GitHub
parent 0ace6189dc
commit 88849ebcc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/development_submitting.md
View File

@ -14,18 +14,20 @@ Submit your improvements, fixes, and new features to Home Assistant one at a tim
2. Make your changes, create a [new platform](creating_platform_index.md), develop a [new component](creating_component_index.md), or fix [issues](https://github.com/home-assistant/home-assistant/issues).
3. [Test your changes](development_testing.md) and check for style violations.
3. [Test your changes](development_testing.md) and check for style violations.
Consider adding tests to ensure that your code works.
4. If everything looks good according to these [musts](development_checklist.md), commit your changes:
`git add .`
`git commit -m "Add some-feature"`
`git commit -m "Add some feature"`
- Write a meaningful commit message and not only `Update` or `Fix`.
- Use a capital letter to start with your commit message.
- Write a meaningful commit message and not only something like `Update` or `Fix`.
- Use a capital letter to start with your commit message and do not finish with a full-stop (period).
- Don't prefix your commit message with `[bla.bla]` or `platform:`.
- Consider adding tests to ensure that your code works.
- Write your commit message using the imperative voice, e.g. `Add some feature` not `Adds some feature`.
5. Push your committed changes back to your fork on GitHub:
@ -33,11 +35,11 @@ Submit your improvements, fixes, and new features to Home Assistant one at a tim
6. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your pull request.
- On GitHub, navigate to the main page of the Home Assistant repository.
- On GitHub, navigate to the [main page of the Home Assistant repository](https://github.com/home-assistant/core).
- In the "Branch" menu, choose the branch that contains your commits (from your fork).
- To the right of the Branch menu, click **New pull request**.
- Use the base branch dropdown menu to select the branch you'd like to merge your changes into, then use the compare branch drop-down menu to choose the topic branch you made your changes in. Make sure the Home Assistant branch matches with your forked branch (`dev`) else you will propose ALL commits between branches.
- Type a title and complete the provided description for your pull request.
- Type a title and complete the provided template for your pull request.
- Click **Create pull request**.
7. Check for comments and suggestions on your pull request and keep an eye on the [CI output](https://travis-ci.org/home-assistant/home-assistant/).