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-04-28 15:27:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
developers.home-assistant/docs/development_submitting.md
Tom Brien d6e06a716d
Replace quotes with tip boxes (#458) 
* Replace quotes with tip boxes

The use of quotes was making important content less clear than the body. Docusaurus now has native tip boxes use remark-admonitions so use these instead.

* Replace json5 codeblock language with json

json5 doesn't have native syntax colouring. Rather than handle with custom css just flip block to have `json` set as language to create same result. All blocks were standard JSON anyway
2020-04-04 14:32:57 -07:00

2.1 KiB
Raw Blame History

title
Submit your work

:::tip Always base your Pull Requests of of the current dev branch, not master. :::

Submit your improvements, fixes, and new features to Home Assistant one at a time, using GitHub Pull Requests. Here are the steps:

  1. From your fork's dev branch, create a new branch to hold your changes:

    git checkout -b some-feature

  2. Make your changes, create a new platform, develop a new component, or fix issues.

  3. Test your changes and check for style violations.

  4. If everything looks good according to these musts, commit your changes:

    git add .

    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.
    • Don't prefix your commit message with [bla.bla] or platform:.
    • Consider adding tests to ensure that your code works.

  5. Push your committed changes back to your fork on GitHub:

    git push origin HEAD

  6. Follow these steps to create your pull request.

    • On GitHub, navigate to the main page of the Home Assistant repository.
    • 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.
    • Click Create pull request.

  7. Check for comments and suggestions on your pull request and keep an eye on the CI output.