Skip to content

Commit 50a5222

Browse files
Merge pull request #117 from sanctuuary/biotools-api
Improve user interface
2 parents 84371b9 + 6032f42 commit 50a5222

File tree

60 files changed

+1504
-1913
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1504
-1913
lines changed
Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
2-
name: Bug Report
3-
about: Create a report to help improve the APE library
4-
title: '[BUG] '
5-
labels: 'bug'
6-
assignees: vedran-kasalica
2+
name: Bug report
3+
about: Create a report to help us improve the APE library
4+
title: ''
5+
labels: bug
6+
assignees: ''
77

88
---
99

10-
**Note:** Not all fields are obligatory, but the more details you provide, the easier it will be for us to address the issue. Feel free to omit sections that you feel are not relevant to your report.
10+
## Checklist before submitting a bug report
11+
12+
- [ ] I have checked the [existing issues](https://github.com/NLeSC/python-template/issues) and couldn't find an issue about this bug.
13+
1114

1215
## Description
1316
<!-- Provide a clear and concise description of what the bug is. -->
@@ -16,12 +19,10 @@ assignees: vedran-kasalica
1619
<!-- Indicate whether this issue is related to the API or the CLI. -->
1720
- [ ] API
1821
- [ ] CLI
22+
- [ ] REST API
1923

20-
## APE Version
21-
<!-- Specify the version of APE you're using. -->
22-
23-
## Java Version
24-
<!-- Specify the Java version you're using. -->
24+
## APE and Java Version
25+
<!-- Specify the version of APE and Java you're using. -->
2526

2627
## Steps to Reproduce
2728
<!-- Provide detailed steps to reproduce the bug: -->
@@ -30,14 +31,7 @@ assignees: vedran-kasalica
3031
3.
3132
4.
3233

33-
## Expected Behavior
34-
<!-- Describe what you expected to happen. -->
35-
36-
## Actual Behavior
37-
<!-- Describe what actually happened. Include complete error messages, screenshots, or logs if possible. -->
3834

39-
## Possible Solution
40-
<!-- Suggest a fix/reason for the bug, if you have one in mind. -->
4135

4236
## Additional Context
4337
<!-- Add any other context about the problem here, such as special configurations, environment details, etc. -->
Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,12 @@
11
---
22
name: Feature Request
33
about: Suggest a new feature or enhancement for the APE library
4-
title: '[FEATURE] '
5-
labels: 'enhancement'
6-
assignees: vedran-kasalica
4+
title: ''
5+
labels: enhancement
76

8-
---
7+
assignees: ''
98

10-
**Note:** Not all fields are obligatory, but the more details you provide, the easier it will be for us to address the issue. Feel free to omit sections that you feel are not relevant to your report.
9+
---
1110

1211
## Feature Description
1312
<!-- Provide a clear and concise description of the feature or enhancement you're proposing. -->
14-
15-
## Is this feature related to a problem? Please describe.
16-
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
17-
18-
## Describe the solution you'd like
19-
<!-- A detailed description of what you want to happen. -->
20-
21-
## Describe alternatives you've considered
22-
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
23-
24-
## API/CLI Impact
25-
<!-- Indicate whether this feature is related to the API, CLI, or both. -->
26-
- [ ] API
27-
- [ ] CLI
28-
- [ ] Both
29-
30-
## Potential Benefits
31-
<!-- Describe the potential benefits this feature would bring to APE library users, such as increased efficiency, new capabilities, or compatibility improvements. -->
32-
33-
## Additional Context
34-
<!-- Add any other context or screenshots about the feature request here. -->

.github/pull_request_template.md

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,18 @@
1-
---
2-
name: Pull Request
3-
about: Submit a pull request to contribute to the APE library
4-
title: ''
5-
labels: ''
6-
assignees: vedran-kasalica
7-
8-
---
9-
10-
**Note:** Not all fields are obligatory, but the more details you provide, the easier it will be for us to address the issue. Feel free to omit sections that you feel are not relevant to your report.
11-
121
## Pull Request Overview
13-
<!-- Provide a brief overview of what this PR aims to accomplish. For instance, this could be a bug fix, feature addition, documentation update, etc. -->
2+
<!-- Briefly describe what this PR does (e.g., bug fix, feature addition, etc.). -->
143

15-
## Related Issue(s) or Pull Request(s)
16-
<!-- Mention any related issues or previous PRs that this PR is related to or dependent on. Use the format `#issue_number` or `#PR_number` to automatically link them. -->
4+
## Related Issue
5+
<!-- Link the related issue using the format `#issue_number`. -->
176

187
## Changes Introduced
19-
<!-- Provide a detailed list of the changes introduced in this PR. Break down new features, bug fixes, enhancements, and API or CLI modifications. -->
20-
21-
## Motivation and Context
22-
<!-- Explain the background for making these changes. What is the current problem you’re solving, or what new functionality are you adding? -->
8+
<!-- List the key changes made in this PR. -->
239

2410
## How Has This Been Tested?
25-
<!-- Describe in detail how you tested your changes. Include details of your testing environment, tests ran, and any other relevant information. If applicable, include steps to reproduce the issue this PR addresses. -->
26-
27-
## API/CLI Changes
28-
<!-- Specify any changes to the API or CLI interface. Include a brief description of the change and how developers should adapt their usage of the library or CLI. -->
29-
30-
## Screenshots (if appropriate):
31-
<!-- Include any relevant screenshots or gifs to visually illustrate the changes made in this PR. -->
32-
33-
## Potential Impacts
34-
<!-- Discuss any potential impacts or side effects of this PR. This includes implications for users, dependencies, or other parts of the system. -->
35-
36-
## Checklist:
37-
<!-- Before submitting this PR, please go through the following checklist and check all the boxes that apply. -->
38-
- [ ] I have followed the [style guidelines](https://github.com/sanctuuary/APE/blob/main/CONTRIBUTION.md#good-java-practices) of this project.
39-
- [ ] I have performed a self-review of my own code.
40-
- [ ] I have commented my code, particularly in hard-to-understand areas.
41-
- [ ] I have made corresponding changes to the documentation (if applicable).
42-
- [ ] My changes generate no new warnings.
43-
- [ ] I have added tests that prove my fix is effective or that my feature works.
44-
- [ ] New and existing unit tests pass locally with my changes.
11+
<!-- Briefly describe how you tested your changes. -->
4512

46-
## Additional Notes
47-
<!-- Any additional information that you believe is important to the review. -->
13+
## Checklist
4814

49-
## Reviewer Checklist:
50-
<!-- Before approving this PR, please go through the following checklist and check all the boxes that apply. -->
51-
- [ ] The code follows the project’s style guide.
52-
- [ ] The changes are well-documented and commented.
53-
- [ ] The tests cover all changes adequately.
54-
- [ ] All checks pass successfully.
15+
- [ ] I have referenced a related issue.
16+
- [ ] I have followed the project’s style guidelines.
17+
- [ ] My changes include tests, if applicable.
18+
- [ ] All tests pass locally.

.github/workflows/mvnbuild.yml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ jobs:
2020
runs-on: ubuntu-latest
2121

2222
steps:
23-
- uses: actions/checkout@v3
24-
- name: Set up JDK 11
25-
uses: actions/setup-java@v3
23+
- uses: actions/checkout@v4
24+
- name: Set up JDK 17
25+
uses: actions/setup-java@v4
2626
with:
27-
java-version: '11'
27+
java-version: '17'
2828
distribution: 'temurin'
2929
cache: maven
3030
- name: Build, test and package with Maven
@@ -35,11 +35,13 @@ jobs:
3535
pip3 install cwlref-runner
3636
- name: Test CWL generation
3737
run: |
38-
git clone https://github.com/Workflomics/domain-annotations
39-
cd domain-annotations/WombatP_tools
40-
java -jar ../../target/APE-*-executable.jar ./config.json
38+
git clone https://github.com/Workflomics/tools-and-domains
39+
cd tools-and-domains/domains/proteomics
40+
java -jar ../../../target/APE-*-executable.jar ./config.json
4141
cd ./CWL
4242
cwltool --enable-dev --validate candidate_workflow_1.cwl
43+
cwltool --enable-dev --validate candidate_workflow_2.cwl
44+
cwltool --enable-dev --validate candidate_workflow_3.cwl
4345
4446
# Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
4547
- name: Update dependency graph

0 commit comments

Comments
 (0)