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

Add header, license, author, version, etc. to all files #131

Open
5iver opened this issue May 23, 2019 · 1 comment
Open

Add header, license, author, version, etc. to all files #131

5iver opened this issue May 23, 2019 · 1 comment

Comments

@5iver
Copy link
Member

5iver commented May 23, 2019

Continuing discussion from #120 (comment)

All files should be formatted following requirements similar to what is found in the OH Coding Guidelines...

  • Header
    • Copyright
    • License hint
  • Documentation
    • File description
    • File authors
    • Version
    • Description for classes
    • Description for methods

The Jython documentation is being reworked, and this implementation can also be used for the main page of the repo and the other languages. Any decision here, should also consider the possible impact to #89.

  1. Should Community contributions be held to the same standards as Core or a subset?
  2. Are a copyright and/or license hint necessary? If not, do we want them?
  3. Where is the script OH uses to update they copyright dates?
  4. Should we add DCO and SAT to verify PRs before merge?
  5. Should we update to EPL2?
  6. What to do with the archived branches?

The final decisions will go into a Coding Guidelines document in the repo.

@openhab-scripters/owners, @openhab-scripters/maintainers

@CrazyIvan359
Copy link
Contributor

I haven't had time to work on #89 / #90 in a couple weeks, unexpected projects came up. I was thinking that given all the changes that have been happening it might be a good idea to rebase or even start a new branch and bring over my work so far. If I understand how git works, I think you'll end up having to manually diff a lot of files. Plus the directory restructure means my folder setup is going to need to change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants