Skip to content

minor readme tweaks; added empty/shell contributing and getting-started#192

Closed
CanDoAnything wants to merge 1 commit intozigpy:devfrom
CanDoAnything:dev
Closed

minor readme tweaks; added empty/shell contributing and getting-started#192
CanDoAnything wants to merge 1 commit intozigpy:devfrom
CanDoAnything:dev

Conversation

@CanDoAnything
Copy link
Copy Markdown
Contributor

edited the readme to put the format in compliance w/ the
markdownlint rules

@CanDoAnything
Copy link
Copy Markdown
Contributor Author

also, i added two template files to be filled out/updated...i'd like to contribute, but not sure how to get started ;)

@Adminiuga
Copy link
Copy Markdown
Collaborator

{what are your rules for contributions?}

Asking real questions here :) We don't have any rules at the moment??? Maybe guidelines? Let's say the guidelines:

  1. code which is easy to understand has greater chance of being merged
  2. we gonna ask questions about the code and why it was implemented in this "particular" way
  3. code must have tests, as we'd like to keep coverage up

{What branch should people do PRs to?}

dev is the default branch so all PRs go against this branch

{I assume unit tests should be required for any new /changed code}

Yes

@Adminiuga
Copy link
Copy Markdown
Collaborator

Getting Started

Basics

{how do i get started using this? I see that Home assistant heavily relies on this library. I'd like to contribute}

Correct, ZHA component relies on a particular library handling Zigbee communication over a specific radio. Each radio relies (extends ControllerApplication class) on Zigpy library.
How to get started? Start using HomeAssistant ZHA component, find the area which you'd like to improve and start tweaking the code i guess?

https://www.youtube.com/playlist?list=PL-awFRrdECXvAs1mN2t2xaI0_bQRh2AqD could be a good primer if you don't have a prior zigbee exposure and would like to get better "under the hood" understanding

@Hedda
Copy link
Copy Markdown
Contributor

Hedda commented Nov 21, 2019

Please also see the somewhat related pull request #204 (as well as #203 which is related to it)

@Hedda
Copy link
Copy Markdown
Contributor

Hedda commented Nov 21, 2019

@Adminiuga Adminiuga closed this Apr 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants