initial commit

CODE_OF_CONDUCT.md

@@ -0,0 +1,81 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+This may be combined into a single statement:
+
+> Allways assume good intent.
+
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,149 @@
+# Contributing to Office
+
+You want to contribute to Office? Welcome! Please read this document to understand what you can do:
+ * [Help Others](#help-others)
+ * [Analyze Issues](#analyze-issues)
+ * [Report an Issue](#report-an-issue)
+ * [Contribute Code](#contribute-code)
+
+## Help Others
+
+You can help Office by helping others who use it and need support.
+
+## Analyze Issues
+
+Analyzing issue reports can be a lot of effort. Any help is welcome!
+Go to [the GitHub issue tracker](https://github.com/klenkes74/Office/issues?state=open) and find an open issue which needs additional work or a bugfix (e.g. issues labeled with "help wanted" or "bug").
+
+Additional work could include any further information, or a gist, or it might be a hint that helps understanding the issue. Maybe you can even find and [contribute](#contribute-code) a bugfix?
+
+## Report an Issue
+
+If you find a bug - behavior of Office code contradicting your expectation - you are welcome to report it.
+We can only handle well-reported, actual bugs, so please follow the guidelines below.
+
+Once you have familiarized with the guidelines, you can go to the [GitHub issue tracker for Office](https://github.com/klenkes74/Office/issues/new) to report the issue.
+
+### Quick Checklist for Bug Reports
+
+Issue report checklist:
+ * Real, current bug
+ * No duplicate
+ * Reproducible
+ * Good summary
+ * Well-documented
+ * Minimal example
+ * Use the bug issue type and fill the template
+
+
+### Issue handling process
+
+When an issue is reported, a committer will look at it and either confirm it as a real issue, close it if it is not an issue, or ask for more details.
+
+An issue that is about a real bug is closed as soon as the fix is committed.
+
+
+### Reporting Security Issues
+
+If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited.
+Please send the related information to [Kaiserpfalz EDV-Service Support](mailto:[email protected]) using [PGP for e-mail encryption](https://global.sap.com/pc/security/keyblock.txt).
+If we don't react within 2 business days, we accept public reporting without complaining about it.
+
+### Usage of Labels
+
+GitHub offers labels to categorize issues. We defined the following labels so far:
+
+Labels for issue categories:
+ * bug: this issue is a bug in the code
+ * enhancement: this issue is a request for a new functionality or an enhancement request
+
+Status of open issues:
+ * help wanted: the feature request is approved and you are invited to contribute
+
+Status/resolution of closed issues:
+ * wontfix: while acknowledged to be an issue, a fix cannot or will not be provided
+
+The labels can only be set and modified by committers.
+
+
+### Issue Reporting Disclaimer
+
+We want to improve the quality of Office and good bug reports are welcome! But our capacity is limited, thus we reserve the right to close or to not process insufficient bug reports in favor of those which are very cleanly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it will not happen - remember: Office is Open Source and comes without warranty.
+
+Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions)
+
+
+## Contribute Code
+
+You are welcome to contribute code to Office in order to fix bugs or to implement new features.
+
+There are three important things to know:
+
+1.  You must be aware of the LGPL 3.0 (which describes contributions) and **agree to the Contributors License Agreement**. This is common practice in all major Open Source projects.
+ For company contributors special rules apply. See the respective section below for details.
+2.  There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines.
+3.  **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of Office and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute).
+
+### Contributor License Agreement
+
+When you contribute (code, documentation, or anything else), you have to be aware that your contribution is covered by the 
+same [LGPL 3.0](https://www.gnu.org/licenses/lgpl-3.0.txt) that is applied to Office itself.
+If you want to contribute to parts not licensed on LGPL then you need to agree to the license given for that part of the 
+software. Please contact [Support]([email protected]) for this.
+In particular you need to agree to the Individual Contributor License Agreement,
+which can be [found here](https://gist.github.com/klenkes74/b76f623edb7830b4344ef2d5e373075e).
+(This applies to all contributors, including those contributing on behalf of a company). If you agree to its content, you 
+simply have to click on the link posted by the Office as a comment to the pull request. Click it to check the CLA, then 
+accept it on the following screen if you agree to it. Office will save this decision for upcoming contributions and will 
+notify you if there is any change to the CLA in the meantime.
+
+#### Company Contributors
+
+If employees of a company contribute code, in **addition** to the individual agreement above, there needs to be one company 
+agreement submitted. This is mainly for the protection of the contributing employees.
+
+A company representative authorized to do so needs to download, fill, and print the
+[Corporate Contributor License Agreement](https://github.com/klenkes74/office/blob/master/KES%20Corporate%20Contributor%20License%20Agreement%20(2019-12-31).pdf)
+form. Then either:
+
+- Scan it and e-mail it to [[email protected]](mailto:[email protected])
+- Send it by traditional letter to: *Kaiserpfalz EDV-Service, Roland T. Lichti, Darmstädter Str. 12, 64625 Bensheim, 
+  GERMANY*
+
+
+### Contribution Content Guidelines
+
+These are some of the rules we try to follow:
+
+- Apply a clean coding style adapted to the surrounding code, even though we are aware the existing code is not fully 
+  clean
+- Use (4)spaces for indentation (except if the modified file consistently uses tabs)
+- Use variable naming conventions like in the other files you are seeing (camelcase)
+- use slf4j for logging
+- Comment your code where it gets non-trivial
+- Keep an eye on performance and memory consumption, properly destroy objects when not used anymore
+- Write a unit test
+- Do not do any incompatible changes, especially do not modify the name or behavior of public API methods or properties
+
+### How to contribute - the Process
+
+1. Make sure the change would be welcome (e.g. a bugfix or a useful feature); best do so by proposing it in a GitHub issue
+2. Create a branch forking the cla-assistant repository and do your change
+3. Commit and push your changes on that branch
+4. In the commit message
+ - Describe the problem you fix with this change.
+ - Describe the effect that this change has from a user's point of view. App crashes and lockups are pretty convincing for 
+   example, but not all bugs are that obvious and should be mentioned in the text.
+ - Describe the technical details of what you changed. It is important to describe the change in a most understandable way 
+   so the reviewer is able to verify that the code is behaving as you intend it to.
+5. If your change fixes an issue reported at GitHub, add the following line to the commit message:
+  - ```Fixes #(issueNumber)```
+  - Do NOT add a colon after "Fixes" - this prevents automatic closing.
+6. Create a Pull Request
+7. Follow the link posted by the Office to your pull request and accept it, as described in detail above.
+8. Wait for our code review and approval, possibly enhancing your change on request
+  - Note that the Office developers also have their regular duties, so depending on the required effort for reviewing, 
+    testing and clarification this may take a while
+
+9. Once the change has been approved we will inform you in a comment
+10. We will close the pull request, feel free to delete the now obsolete branch

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.