Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update guidelines.md #933

Merged
merged 4 commits into from
Apr 11, 2019
Merged

Update guidelines.md #933

merged 4 commits into from
Apr 11, 2019

Conversation

davidgraeff
Copy link
Member

@davidgraeff davidgraeff commented Apr 9, 2019

  • Remove eclipse smarthome references.
  • More concise
  • Add examples for logging
  • Merge null annotations part into this file
  • Use MUST instead of SHOULD in many places, where we nowadays enforce such rules
  • OSGi framework level R5

This was one big blob of text. I have added some life to it with examples and an extension directory layout etc.

The most controversial point is OSGi R5, but I think it is about to be time. We are running openHAB on R6 already and DS 1.3 is just to helpful to ignore it.

Signed-off-by: David Graeff david.graeff@web.de

* Remove eclipse smarthome references.
* More concise
* Add examples for logging
* Merge null annotations part into this file
* Use MUST instead of SHOULD in many places, where we nowadays enforce such rules
* OSGi framework level R5

Signed-off-by: David Graeff <david.graeff@web.de>
@netlify
Copy link

netlify bot commented Apr 9, 2019

Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Built with commit 304ef79

https://deploy-preview-933--openhab-docs-preview.netlify.com

Copy link
Contributor

@5iver 5iver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great update and this information is needed. Here are some suggestions for polishing it up a bit.

developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
review comments

Signed-off-by: David Graeff <david.graeff@web.de>
davidgraeff pushed a commit to davidgraeff/openhab-docs that referenced this pull request Apr 10, 2019
For openhab#933

Signed-off-by: David Gräff <david.graeff@web.de>
Confectrician pushed a commit that referenced this pull request Apr 11, 2019
For #933

Signed-off-by: David Gräff <david.graeff@web.de>
Copy link
Contributor

@Confectrician Confectrician left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good so far.
Thanks to @openhab-5iver for the content review.

I have added some minor style comments below.

developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
developers/development/guidelines.md Outdated Show resolved Hide resolved
Confectrician and others added 2 commits April 11, 2019 22:06
Co-Authored-By: davidgraeff <david.graeff@web.de>
review comments

Signed-off-by: David Graeff <david.graeff@web.de>
@davidgraeff
Copy link
Member Author

Comments addressed

@Confectrician Confectrician merged commit b5ae868 into openhab:master Apr 11, 2019
@Confectrician Confectrician added this to the 2.x.x milestone Nov 18, 2022
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.

None yet

3 participants