|
5 | 5 | Please carefully follow [the setup guide for the codestyle](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html).
|
6 | 6 | Afterwards, please [run checkstyle locally](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#run-checkstyle) and fix the issues.
|
7 | 7 |
|
| 8 | +
|
8 | 9 | In case of issues with the import order, double check that you [activated Auto Import](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#enable-proper-import-cleanup).
|
9 | 10 | You can trigger fixing imports by pressing <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>O</kbd> to trigger [Optimize Imports](https://www.jetbrains.com/guide/tips/optimize-imports/).
|
10 | 11 | - jobName: OpenRewrite
|
|
14 | 15 | The issues found can be **automatically fixed**.
|
15 | 16 | Please execute the gradle task *`rewriteRun`*, check the results, commit, and push.
|
16 | 17 |
|
| 18 | +
|
17 | 19 | You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".
|
18 | 20 | - jobName: Modernizer
|
19 | 21 | message: >
|
20 | 22 | Your code currently does not meet JabRef's code guidelines.
|
21 | 23 | We use [Gradle Modernizer Plugin](https://github.com/andygoossens/gradle-modernizer-plugin#gradle-modernizer-plugin) to ensure "modern" Java coding practices.
|
22 | 24 | Please fix the detected errors, commit, and push.
|
23 | 25 |
|
| 26 | +
|
24 | 27 | You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "Modernizer".
|
25 | 28 | - jobName: Markdown
|
26 | 29 | message: >
|
27 | 30 | You modified Markdown (`*.md`) files and did not meet JabRef's rules for consistently formatted Markdown files.
|
28 | 31 | To ensure consistent styling, we have [markdown-lint](https://github.com/DavidAnson/markdownlint) in place.
|
29 | 32 | [Markdown lint's rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#rules) help to keep our Markdown files consistent within this repository and consistent with the Markdown files outside here.
|
30 | 33 |
|
| 34 | +
|
31 | 35 | You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "Markdown".
|
32 | 36 | - jobName: CHANGELOG.md
|
33 | 37 | message: |
|
|
39 | 43 | In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details".
|
40 | 44 | This brings you to the test output.
|
41 | 45 |
|
| 46 | +
|
42 | 47 | You can then run these tests in IntelliJ to reproduce the failing tests locally.
|
43 | 48 | We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide.
|
44 | 49 | - jobName: no-force-push
|
45 | 50 | message: >
|
46 | 51 | Do not force-push!
|
47 |
| - Force push is off limits and very bad style when working together on a project. |
48 |
| - ([Mainly because it is not supported well by GitHub istself.](https://github.com/orgs/community/discussions/3478)) |
49 |
| - Commits will be lost, comments on commits will loose their context. |
50 |
| - This makes it harder to review. |
51 |
| - In the end, all commits will be [squashed](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) either way before being merged into the `main`` branch. |
52 |
| -- jobName: move_issue |
| 52 | + Force pushing is a very bad practice when working together on a project (mainly because it is [not supported well by GitHub itself](https://github.com/orgs/community/discussions/3478)). |
| 53 | + Commits are lost and comments on commits lose their context, thus making it harder to review changes. |
| 54 | + At the end, all commits will be [squashed](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) anyway before being merged into the `main` branch. |
| 55 | +- jobName: 'Mark issue as in progress' |
53 | 56 | message: |
|
54 | 57 | Your pull request needs to link an issue.
|
55 | 58 |
|
|
81 | 84 | - ✅ `Fixes https://github.com/JabRef/jabref/issues/xyz` links pull-request to issue. Merging the PR will close the issue.
|
82 | 85 | - ✅ `Fixes https://github.com/Koppor/jabref/issues/xyz` links pull-request to issue. Merging the PR will close the issue.
|
83 | 86 | - ❌ `Fixes [#xyz](https://github.com/JabRef/jabref/issues/xyz)` links pull-request to issue. Merging the PR will **NOT** close the issue.
|
| 87 | +- jobName: 'Conflicts with target branch' |
| 88 | + message: > |
| 89 | + Your pull request conflicts with the target branch. |
| 90 | +
|
| 91 | +
|
| 92 | + Please [merge `upstream/main`](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-command-line) with your code. |
| 93 | + For a step-by-step guide to resolve merge conflicts, see <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line>. |
| 94 | +- jobName: 'Submodules not modified' |
| 95 | + message: > |
| 96 | + Your pull request modified git submodules. |
| 97 | +
|
| 98 | +
|
| 99 | + Please follow our [FAQ on submodules](https://devdocs.jabref.org/code-howtos/faq.html#submodules) to fix. |
0 commit comments