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
Copy file name to clipboardExpand all lines: documentation/IDEasy-contribution-getting-started.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ If some days have passed meanwhile you should merge changes that meanwhile happe
39
39
git pull upstream main
40
40
```
41
41
42
-
Once you are complete and everything is merged and comitted, you can push your local feature branch and make it a remote branch of your fork on github:
42
+
Once you are complete and everything is merged and committed, you can push your local feature branch and make it a remote branch of your fork on github:
Now you can go to https://github.com/devonfw/ideasy/pulls and create the pull-request (PR) from your new feature.
49
49
Therefore, please click on the right down arrow of the green button and choose `Create draft pull request` and then click on `Draft pull request`.
50
50
When the checks have completed you can check the link:DoD.adoc[Definition-of-Done] (DoD).
51
-
Once, all checks of the DoD are addressed, you can go the the very bottom of the PR and click on `Ready for review` what will take the PR out of the draft mode.
51
+
Once, all checks of the DoD are addressed, you can go to the very bottom of the PR and click on `Ready for review` what will take the PR out of the draft mode.
52
52
FYI: If you forgot the upstream merge (`git pull upstream/main`) or the upstream changed again while your PR is still open, you will see `This branch is out-of-date with the base branch` at the bottom of your PR and can click on `Update branch`.
53
53
54
54
For further development and testing, it is recommended to xref:symbolic-links[symlink] the modified scripts into your IDEasy installation.
@@ -136,13 +136,13 @@ You probably know this black box on Windows (the Command Prompt) that accepts co
136
136
Now for users of a Linux Distribution there is something similar, but way more powerful, usually called "Bourne Again Shell", or in short Bash.
137
137
This Command Line Interface or "Shell" is what we use most often when implementing something new for our Command-Line-Tool with the name IDEasy. https://www.youtube.com/watch?v=I4EWvMFj37g[Have a look at Bash in 150 Seconds.]
138
138
For MacOS you often also use BASH.
139
-
That's why it is often enough to implement code for Mac or Linux (at least to some extend as you'll see soon enough) to be able to use it on both Operating Systems.
139
+
That's why it is often enough to implement code for Mac or Linux (at least to some extent as you'll see soon enough) to be able to use it on both Operating Systems.
140
140
141
141
Let's get to the practical part of the Bash-usage.
142
142
143
143
**If you are using Windows**, make sure that you have git-bash installed, so you can execute the Bash commands mentioned in this introduction. (https://git-scm.com/download/win[Here you can find git for windows]).
144
144
In some cases later on you may want or need to use WSL.
145
-
Our project teams standard way is to install WSL via Rancher Desktop, which is easily installable with the IDEasy by using the command `ide install docker`.
145
+
Our project team's standard way is to install WSL via Rancher Desktop, which is easily installable with the IDEasy by using the command `ide install docker`.
146
146
If you don't have the IDEasy yet, then you can follow (https://github.com/devonfw/IDEasy/blob/main/documentation/setup.adoc[this guide])
147
147
148
148
The https://www.youtube.com/watch?v=oxuRxtrO2Ag[following video] gives you some important and helpful basics, still you don't need to know all of these commands directly by heart.
Copy file name to clipboardExpand all lines: documentation/IDEasy-contribution-rules-and-guidelines.adoc
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ toc::[]
3
3
4
4
== Project Board
5
5
6
-
The IDEasy *Project Board* with its Columns should be used as followed:
6
+
The IDEasy *Project Board* with its Columns should be used as follows:
7
7
8
8
* *New*: [.underline]#Issues# that are newly created and have yet to be refined
9
9
* *Backlog*: [.underline]#Issues# that are refined but not yet being worked on
@@ -18,9 +18,9 @@ The PR may be in draft state, otherwise the PR should be in one of the following
18
18
The reviewer is the assignee of the PR and the author remains assignee (2 assignees).
19
19
* *In Review*: [.underline]#Pull Request# that is to be or currently under review by a final reviewer that is the assignee of the PR together with the author (2 assignees).
20
20
Typically the final reviewer is the Project Owner (currently hohwille) but it may also be done by team members with longer experience in the project.
21
-
* *Done*: [.underline]#Issues# and [.underline]#Pull Request# that have been completed and merged.
21
+
* *Done*: [.underline]#Issues# and [.underline]#Pull Requests# that have been completed and merged.
22
22
23
-
To better organize the board and avoid overload, only pull request are allowed in the review columns.
23
+
To better organize the board and avoid overload, only pull requests are allowed in the review columns.
24
24
Issues remain `in progress` until completed via merge of PR.
25
25
26
26
General conventions for contributions to devonfw can be found
@@ -35,20 +35,20 @@ The following conventions are added on top by the IDEasy team from the learnings
35
35
** Closes
36
36
** For more info see (https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
37
37
* The description can also contain additional information for the PR and changed files.
38
-
* More complicated pull request should contain a short summary of the changed files and commits.
39
-
* In addition, other issue or PRs can be linked, most commonly with keyword like:
38
+
* More complicated pull requests should contain a short summary of the changed files and commits.
39
+
* In addition, other issues or PRs can be linked, most commonly with keyword like:
40
40
** Blocked by
41
41
** Related
42
42
** Merge first
43
43
* Comments requested changes and other conversations in a pull request should only be resolved by the person that started them and NOT the creator of the pull request.
44
-
(As the permissions might not always allow this, a final comment by the creator of the conversations, saying it can be resolved is the second 0ption.)
45
-
* Conversations should be answered by the owner of the pull request, so to show that the suggestion was either implemented or acknowledged.
44
+
(As the permissions might not always allow this, a final comment by the creator of the conversations, saying it can be resolved is the second option.)
45
+
* Conversations should be answered by the owner of the pull request to show that the suggestion was either implemented or acknowledged.
46
46
* The pull request should be assigned to the person that has work on the PR, either the reviewer or the owner depending on whether a review is to be done or the review needs to be addressed.
47
-
* A pull request should not be a draft when it is in a review.
47
+
* A pull request should not be a draft when it is in review.
48
48
49
49
== Commit
50
50
51
-
* Commit messages should always start with the issue number and a hashtag, so to automatically link the corresponding issue.
51
+
* Commit messages should always start with the issue number and a hashtag to automatically link the corresponding issue.
52
52
* The title of a commit should be kept short and informative.
53
53
* The description of a commit message can be used to elaborate on the title.
54
54
* Always commit your changes in small logical units associated with an issue (see above section) using the commit message format:
@@ -89,7 +89,7 @@ devonfw/IDEasy#5: added REST service for tablemanagement
89
89
90
90
* The reviewer should be assigned to the PR, if a review is needed, or the requested changes need to be checked and conversations need to be resolved.
91
91
* After completing the review, the owner of the PR should be assigned.
92
-
* After the team review is finished the PO (hohwille) should be assigned.
92
+
* After the team review is finished, the PO (hohwille) should be assigned.
93
93
* While reviewing a useful tool is the web ide provided by github.
94
94
Simply open the `files changed` tab and press `.` on the keyboard.
95
95
* Another useful tool is to use the feature “insert a suggestion” while writing a comment (for more detail see
0 commit comments