Skip to content
This repository was archived by the owner on Nov 19, 2021. It is now read-only.

Commit 6963f0b

Browse files
Jorge-DacalJorge-Dacal
committedJun 29, 2018
add Apache Licence, code of conduct, contributing guide and templates
1 parent f179da4 commit 6963f0b

6 files changed

+438
-21
lines changed
 

‎CODE_OF_CONDUCT.asciidoc

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
:toc: macro
2+
toc::[]
3+
4+
:doctype: book
5+
:reproducible:
6+
:source-highlighter: rouge
7+
:listing-caption: Listing
8+
9+
IMPORTANT: This document is the *Official Covenant Code of Conduct* that must be present in every OASP or Devonfw project at the root folder as `CODE_OF_CONDUCT.asciidoc` or `CODE_OF_CONDUCT.md`. Please, include this contents in your repository and the *Product Owner email address* in the right place below.
10+
11+
== Contributor Covenant Code of Conduct
12+
13+
=== Our Pledge
14+
15+
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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
16+
17+
=== Our Standards
18+
19+
Examples of behavior that contributes to creating a positive environment include:
20+
21+
* Using welcoming and inclusive language
22+
* Being respectful of differing viewpoints and experiences
23+
* Gracefully accepting constructive criticism
24+
* Focusing on what is best for the community
25+
* Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
30+
* Trolling, insulting/derogatory comments, and personal or political attacks
31+
* Public or private harassment
32+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
33+
* Other conduct which could reasonably be considered inappropriate in a professional setting
34+
35+
=== Our Responsibilities
36+
37+
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.
38+
39+
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.
40+
41+
=== Scope
42+
43+
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.
44+
45+
=== Enforcement
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at *[INSERT PRODUCT OWNER EMAIL ADDRESS]*. 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.
48+
49+
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.
50+
51+
=== Attribution
52+
53+
This Code of Conduct is adapted from the https://www.contributor-covenant.org[Contributor Covenant], version 1.4,
54+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎CONTRIBUTING_GUIDE.asciidoc

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
:toc: macro
2+
toc::[]
3+
4+
:doctype: book
5+
:reproducible:
6+
:source-highlighter: rouge
7+
:listing-caption: Listing
8+
9+
== Code Contributions
10+
11+
=== Notes on Code Contributions
12+
13+
Both projects, devon and OASP, are intended to be easy to contribute to. One service allowing such simplicity is GitHub was therefore selected as preferred collaboration platform.
14+
15+
In order to contribute code, git and GitHub specific pull-requests are being used.
16+
17+
It is mandatory to follow the <<Contributor Covenant Code of Conduct,code of conduct>> that must be present in the root of every OSS or private project as `CODE_OF_CONDUCT.asciidoc` or `CODE_OF_CONDUCT.md`.
18+
19+
=== Introduction to Git and GitHub
20+
21+
Git is a version control system used for a coordinated and versioned collaboration of computer files. It enables a project to be easily worked on by multiple developers and contributors.
22+
23+
GitHub is an online repository used by deonvfw and OASP in order to host the corresponding files. Using the command line tool or the GUI Tool "GitHub Desktop" a user can easily manage project files. There are private and public repositories. Public ones (like OASP) can be accessed by everyone, private repositories (like devon) require access permissions.
24+
25+
==== Creating a new user account
26+
27+
The devon and OASP projects use GitHub as hosting service. Therefore you'll need an account to allow collaboration. Visit https://github.com/join?source=header-home[this page] to create a new account. If available, use *your CORP username* as GitHub username and *your CORP email address*.
28+
29+
A GitHub account is essential for contributing code and gaining permissions to access private repositories.
30+
31+
==== Git Basics
32+
33+
An in-depth documentation on basic Git syntax and usage can be found on the https://git-scm.com/docs[official Git homepage]. Another helpful and easy to follow instruction can be found http://rogerdudler.github.io/git-guide/[here].
34+
35+
=== Structure of our projects
36+
37+
In total, there are three GitHub projects regarding OASP and devon:
38+
39+
* link:https://github.com/oasp-forge[*oasp-forge*]
40+
+
41+
Repository used for work on the guide - Similar to the according devon repository link:https://github.com/devonfw/devon-guide/wiki[*devon-guide*]
42+
* link:https://github.com/oasp/[*oasp*]
43+
+
44+
The official _Open Application Standard Platform_ project repository. Usually, two main branches exist:
45+
46+
** *develop*
47+
+
48+
This branch contains software in the state of being in development.
49+
** *master*
50+
+
51+
This branch contains software in release state.
52+
53+
* link:https://github.com/devonfw/[*devonfw*]
54+
+
55+
This is a private repository. You have to be logged in and have permissions to access the project and its repositories. Similar to OASP, there are usually two branches:
56+
57+
** *develop*
58+
** *master*
59+
60+
=== Contributing to our projects
61+
62+
In order to contribute to our projects, developers must follow the following <<Development Guidelines,development guidelines>>. Other sources about contributing to devon/OASP:
63+
64+
* https://github.com/oasp/oasp4j/wiki/oasp-code-contributions[OASP code contributions]
65+
* https://github.com/oasp/oasp4j/wiki/oasp-documentation[OASP documentation]
66+
* https://troom.capgemini.com/sites/vcc/devon/collaboration.aspx[Devon collaboration]
67+
68+
*Every project must include the following files* in order to establish the contributing rules and facilitate the process:
69+
70+
* `CONTRIBUTING.asciidoc` that establishes the specific guidelines of contributing in a project repository.
71+
* `CODE_OF_CONDUCT.asciidoc` mandatory to contribute.
72+
* `ISSUE_TEMPLATE.asciidoc` that defines the appropriated way to submit an issue in a project repository.
73+
* `PULL_REQUEST_TEMPLATE.asciidoc` that specifies the rules in order to submit a pull request in a project repository.
74+
75+
This files should be included at the root folder or in a `docs` folder. https://github.com/stevemao/github-issue-templates[This repository] is a good resource to find the perfect templates for issues and pull requests that fit in your repository.
76+
77+
==== Process of contributing code to the devon/OASP projects
78+
79+
* Use the issue tracker to check whether the issue you would like to be working on exists. Otherwise create a new issue.
80+
+
81+
.Using GitHub's issue tracker
82+
image::images/contributing/issue_list.PNG[Issue list, width="450", link="images/contributing/issue_list.PNG"]
83+
84+
* Before making more complex changes you should probably notify the community. The worst case would be you investing time and effort into something that'll be later rejected. Oftentimes the https://www.yammer.com/capgemini.com/#/threads/inGroup?type=in_group&feedId=5030942&view=all[Devon Community] on Yammer will have the right answer.
85+
* Assign yourself to the issue you would like to work on. If a member was already assigned to your preferred issue, get in contact to contribute to the same issue.
86+
* Fork the desired repository to your corporate GitHub account. Afterwards you'll have your own copy of the repository you'd like to work on.
87+
* Create a new branch for your feature/bugfix. Check out the develop branch for the upcoming release. The following changes will afterwards be merged when the new version is released.
88+
* Please read the <<Working with forked repositories,Working with forked repositories>> document to learn all about this topic.
89+
** Check out the develop branch
90+
+
91+
[source, bash]
92+
----
93+
git checkout develop-x.y.z
94+
----
95+
** Create a new branch
96+
+
97+
[source, bash]
98+
----
99+
git checkout -b myBranchName
100+
----
101+
* Apply your modifications according to the https://github.com/oasp/oasp4j/wiki/coding-conventions[coding conventions] to the newly created branch
102+
* Verify your changes to only include relevant and required changes.
103+
* Commit your changes locally
104+
** When commiting changes please follow this pattern for your commit message:
105+
+
106+
[source]
107+
----
108+
#<issueId>: <change description>
109+
----
110+
111+
** When working on multiple different repositories, the actual repository name of the change should also be declared in the commit message:
112+
+
113+
114+
[source]
115+
----
116+
<project>/<repository>#<issueId>: <change description>
117+
----
118+
+
119+
For example:
120+
+
121+
[source]
122+
----
123+
oasp/oasp4j#1: added REST service for tablemanagement
124+
----
125+
+
126+
*Note:* Starting directly with a # symbol will comment out the line when using the editor to insert a commit message. Instead, you should use a prefix like a space or simply typing "Issue". E.g.:
127+
+
128+
[source]
129+
----
130+
Issue #4: Added some new feature, fixed some bug
131+
----
132+
+
133+
The language to be used for commit messages is English.
134+
* Push the changes to your Fork of the repository
135+
* After completing the issue/bugfix/feature, use the _pull request_ function in GitHub. This feature allows other members to look over your branch, automated CI systems may test your changes and finally apply the changes to the corresponding branch (if no conflicts occur).
136+
+
137+
Use the tab "Pull requests" and the button labeled "New pull request". Afterwards you can _Choose different branches or forks above to discuss and review changes_.
138+
139+
=== Reviewing Pull Requests
140+
141+
Detailed information about revieweing can be found on the https://help.github.com/articles/reviewing-changes-in-pull-requests/[official topic on GitHub Pull Requests].
142+
143+
There are two different methods to review Pull Requests:
144+
145+
* *Human based reviews*
146+
+
147+
Other project members are able to discuss the changes made in the pull request by having insight into changed files and file differences by commenting.
148+
+
149+
.People can add comments to pull requests and suggest further changes
150+
image::images/contributing/pr_commenting.PNG[Commenting on pull requests, width="450", link="images/contributing/pr_commenting.PNG"]
151+
152+
* *CI based reviews*
153+
+
154+
CI Systems like https://jenkins.io/[Jenkins] or https://travis-ci.org/[Travis.ci] are able to listen for new pull requests on specified projects. As soon as the request was made, Travis for example checks out the to-be-merged branch and builds it. This enables an automated build which could even include testcases. Finally, the CI approves the pull requests if the build was built and tested successfully, otherwise it'll let the project members know that something went wrong.
155+
+
156+
.If Travis fails to build a project, it'll post the results directly to the pull request
157+
image::images/contributing/travis_failure.png[Travis failed to build, width="450", link="images/contributing/travis_failure.png"]
158+
+
159+
Combining these two possibilities should accelerate the reviewing process of pull requests.

‎ISSUE_TEMPLATE.asciidoc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Category: Bug or enhancement
2+
3+
Severity: Low , Medium, High, Critical
4+
5+
Expected behaviour (In case of bug)
6+
7+
Actual/current behaviour (In case of bug)
8+
9+
Steps to reproduce (In case of bug)
10+
11+
Description of issue / expected enhacement /Comments
12+
13+
Your environment - windows/Linux, Devonfw version , component

‎LICENSE

+202-21
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,202 @@
1-
The MIT License
2-
3-
Copyright (c) 2016 by Teradata. All rights reserved. http://teradata.com
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2015-2018 Capgemini SE.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎PR_TEMPLATE.asciidoc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Issue Number
2+
3+
Implementation description
4+
5+
@devonfw

‎TERMS_OF_USE.asciidoc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
We provide the computer program of devonfw and OASP (the Open Application Standard Platform), (hereinafter "Software") free of charge to download. Regarding this software the license terms of the Apache License 2.0 apply. The user shall be responsible to provide the required system environment for using the software. In accordance with the license terms of the Apache License 2.0, the user is entitled to use the Software in own / other projects (also commercial projects), provided that the copyright notice will be taken.
2+
3+
The software also requires open-source components of third-parties (providers), for which the respective open source license terms apply. The open-source components of third parties are not from us and must be licensed directly from the respective third party. The rights to use will be granted directly by the respective right owner to the extent of each relevant open source license terms. The user himself can download the desired third party component from the servers of the respective provider and install them in his own environment.
4+
5+
For a full list of the open-source components of third-parties and applicable license terms, see https://oasp.github.io/TermsOfUse

0 commit comments

Comments
 (0)
This repository has been archived.