You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 10, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: CODE_OF_CONDUCT.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ toc::[]
9
9
:source-highlighter: rouge
10
10
:listing-caption: Listing
11
11
12
-
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.
12
+
IMPORTANT: This document is the *Official Covenant Code of Conduct* that must be present in every 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.
Copy file name to clipboardExpand all lines: CONTRIBUTING_GUIDE.adoc
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ toc::[]
13
13
14
14
=== Notes on Code Contributions
15
15
16
-
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.
16
+
project devonfw is intended to be easy to contribute to. One service allowing such simplicity is GitHub was therefore selected as preferred collaboration platform.
17
17
18
18
In order to contribute code, git and GitHub specific pull-requests are being used.
19
19
@@ -23,11 +23,11 @@ It is mandatory to follow the <<Contributor Covenant Code of Conduct,code of con
23
23
24
24
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.
25
25
26
-
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.
26
+
GitHub is an online repository used by deonvfw 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.
27
27
28
28
==== Creating a new user account
29
29
30
-
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*.
30
+
The devonfw project 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*.
31
31
32
32
A GitHub account is essential for contributing code and gaining permissions to access private repositories.
33
33
@@ -37,12 +37,12 @@ An in-depth documentation on basic Git syntax and usage can be found on the http
37
37
38
38
=== Structure of our projects
39
39
40
-
In total, there are three GitHub projects regarding OASP and devon:
40
+
In total, there are three GitHub projects regarding devonfw:
Repository used for work on the guide - Similar to the according devon repository link:https://github.com/devonfw/devon-guide/wiki[*devon-guide*]
45
-
* link:https://github.com/oasp/[*oasp*]
45
+
* link:https://github.com/devonfw/[*devonfw*]
46
46
+
47
47
The official _Open Application Standard Platform_ project repository. Usually, two main branches exist:
48
48
@@ -55,17 +55,17 @@ This branch contains software in release state.
55
55
56
56
* link:https://github.com/devonfw/[*devonfw*]
57
57
+
58
-
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:
58
+
You have to be logged in and have permissions to access the project and its repositories. Similar to DEVONFW, there are usually two branches:
59
59
60
60
** *develop*
61
61
** *master*
62
62
63
63
=== Contributing to our projects
64
64
65
-
In order to contribute to our projects, developers must follow the following <<Development Guidelines,development guidelines>>. Other sources about contributing to devon/OASP:
65
+
In order to contribute to our projects, developers must follow the following <<Development Guidelines,development guidelines>>. Other sources about contributing to devonfw:
*Every project must include the following files* in order to establish the contributing rules and facilitate the process:
@@ -77,7 +77,7 @@ In order to contribute to our projects, developers must follow the following <<D
77
77
78
78
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.
79
79
80
-
==== Process of contributing code to the devon/OASP projects
80
+
==== Process of contributing code to the devonfw project
81
81
82
82
* Use the issue tracker to check whether the issue you would like to be working on exists. Otherwise create a new issue.
83
83
+
@@ -101,7 +101,7 @@ git checkout develop-x.y.z
101
101
----
102
102
git checkout -b myBranchName
103
103
----
104
-
* Apply your modifications according to the https://github.com/oasp/oasp4j/wiki/coding-conventions[coding conventions] to the newly created branch
104
+
* Apply your modifications according to the https://github.com/devonfw/devon4j/wiki/coding-conventions[coding conventions] to the newly created branch
105
105
* Verify your changes to only include relevant and required changes.
106
106
* Commit your changes locally
107
107
** When commiting changes please follow this pattern for your commit message:
@@ -123,7 +123,7 @@ For example:
123
123
+
124
124
[source]
125
125
----
126
-
oasp/oasp4j#1: added REST service for tablemanagement
126
+
devonfw/devon4j#1: added REST service for tablemanagement
127
127
----
128
128
+
129
129
*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.:
0 commit comments