Skip to content

Commit a287f81

Browse files
authored
Update contribution guidelines and README (#122)
Dropping support for Gerrit as our PR mechanism as it is yet another barrier to contribution. Updated the readme to tag the extension ids for Kotlin as that is a major example. Update the Github Actions so they run on PRs.
1 parent 28ae65f commit a287f81

File tree

5 files changed

+24
-73
lines changed

5 files changed

+24
-73
lines changed

.github/workflows/java16.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
name: Integration Tests on Java 16
22

3-
on: [push]
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
48

59
jobs:
610
build:

.github/workflows/java8.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
name: Integration Tests on Java 8
22

3-
on: [push]
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
48

59
jobs:
610
build:

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ target
99
!.gitignore
1010
!.gitattributes
1111
!.gitkeep
12+
13+
# and iDEA
14+
*.iml

CONTRIBUTING.adoc

+8-68
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ easy and effective for everyone involved.
99

1010
The https://github.com/repaint-io/maven-tiles/issues[issue tracker] is
1111
the preferred channel for reporting all bugs or feature requests for the
12-
plugin. Pull requests are accepted but will be managed via
13-
https://review.gerrithub.io/#/q/project:repaint-io/maven-tiles[GerritHub.io] ( see below )
14-
but please respect the following restrictions:
12+
plugin.
1513

1614
* Please **do not** use the issue tracker for personal support requests.
1715

@@ -21,73 +19,15 @@ but please respect the following restrictions:
2119
* Please **do not** derail or troll issues. Keep the discussion on topic and
2220
respect the opinions of others.
2321

24-
=== GerritHub.io
22+
=== Submitting a patch
2523

26-
Rather than using Github's Pull Request model, the _tiles-maven-plugin_ is using the
27-
https://code.google.com/p/gerrit/[Gerrit] code review tool via the public http://gerrithub.io[GerritHub.io]
28-
service for pre-merge code review.
24+
Pull requests are accepted and managed via Github but please respect the following restrictions:
2925

30-
Github pull requests SHOULD be automatically pulled into GerritHub as reviews, and any
31-
updated changes will be expected to be pushed/managed via GerritHub.io, however direct review submissions
32-
via GerritHub.io are preferred.
33-
34-
==== Submission via GerritHub
35-
36-
Clone the repository::
37-
[source,shell]
38-
----
39-
git clone https://review.gerrithub.io/repaint-io/maven-tiles
40-
----
41-
42-
Install Gerrit Commit Message Hook::
43-
[source,shell]
44-
----
45-
curl -Lo .git/hooks/commit-msg http://review.gerrithub.io/tools/hooks/commit-msg
46-
----
47-
48-
Make changes and submit::
49-
[source,shell]
50-
----
51-
git add ...
52-
git commit ...
53-
git push origin HEAD:refs/for/master
54-
----
55-
56-
Update changes and resubmit::
57-
[source,shell]
58-
----
59-
git add ...
60-
git commit --amend ...
61-
git push origin HEAD:refs/for/master
62-
----
63-
64-
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
26+
NOTE: **IMPORTANT**: By submitting a patch, you agree to allow the project owners to
6527
license your work under the terms of the Apache 2.0 License.
6628

67-
If you've already forked the Maven Tiles Github repository, you can configure
68-
your existing clone to support GerritHub submission as follows:
29+
Please do not over-commit, make each commit meaningful and consider squashing your commits. We may
30+
ask you to do that before considering merging your commit. Our ideal is one commit per
31+
issue if possible.
32+
6933

70-
Configure an existing clone::
71-
[source,shell]
72-
----
73-
git remote add gerrithub https://review.gerrithub.io/repaint-io/maven-tiles
74-
----
75-
Install Gerrit Commit Message Hook::
76-
[source,shell]
77-
----
78-
curl -Lo .git/hooks/commit-msg http://review.gerrithub.io/tools/hooks/commit-msg
79-
----
80-
Make changes and submit::
81-
[source,shell]
82-
----
83-
git add ...
84-
git commit ...
85-
git push gerrithub HEAD:refs/for/master
86-
----
87-
Update changes and resubmit::
88-
[source,shell]
89-
----
90-
git add ...
91-
git commit --amend ...
92-
git push gerrithub HEAD:refs/for/master
93-
----

README.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,8 @@ section when processing and use it directly.
129129

130130
Execution ids within tiles are prepended with the gav parameters of the tile that included the execution, for easier
131131
debugging / tracing. If this is not desired, adding a configuration attribute `tiles-keep-id="true"` or entry
132-
`<tiles-keep-id>true<tiles-keep-id>` will keep the original id.
132+
`<tiles-keep-id>true<tiles-keep-id>` will keep the original id. If you are using the _Kotlin Maven plugin_, you will
133+
need to use this or it will not work.
133134

134135
[source,xml,indent=0]
135136
.tile.xml
@@ -255,9 +256,8 @@ As a use case, an example of how it will be used for my projects.
255256

256257
Richard will have:
257258

258-
- *java6-tile* - for those projects that have to remain Java 6
259-
- *java7-tile* - for those projects that haven't yet moved to Java 8
260259
- *java8-tile* - for those projects that are on Java 8
260+
- *java11-tile* - for those projects that are on Java LTS (11)
261261
- *groovy-tile* - which defines the build structure necessary to build a Groovy project, including GMavenPlus, GroovyDoc
262262
and Source plugins
263263
- *java-tile* - for Java only projects which include all the Javadoc and Source plugins

0 commit comments

Comments
 (0)