Skip to content

Commit 2a19c16

Browse files
mbtoolsmbtools
authored
Initial commit
0 parents  commit 2a19c16

File tree

11 files changed

+1128
-0
lines changed

11 files changed

+1128
-0
lines changed

‎.abapgit.xml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
3+
<asx:values>
4+
<DATA>
5+
<MASTER_LANGUAGE>E</MASTER_LANGUAGE>
6+
<STARTING_FOLDER>/src/</STARTING_FOLDER>
7+
<FOLDER_LOGIC>PREFIX</FOLDER_LOGIC>
8+
<REQUIREMENTS>
9+
<item>
10+
<COMPONENT>SAP_BASIS</COMPONENT>
11+
<MIN_RELEASE>740</MIN_RELEASE>
12+
</item>
13+
</REQUIREMENTS>
14+
</DATA>
15+
</asx:values>
16+
</asx:abap>

‎.editorconfig

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# 1 space indentation for xml files
7+
[*.xml]
8+
charset = utf-8
9+
end_of_line = lf
10+
insert_final_newline = true
11+
trim_trailing_whitespace = true
12+
indent_style = space
13+
indent_size = 1
14+
15+
# match the format used by abapGit
16+
[*.{abap,js,json,html,css}]
17+
charset = utf-8
18+
end_of_line = lf
19+
insert_final_newline = true
20+
trim_trailing_whitespace = true
21+
indent_size = 2
22+
indent_style = space
23+
24+
# YAML and Bash Files
25+
[*.{yml,yaml,sh}]
26+
charset = utf-8
27+
end_of_line = lf
28+
insert_final_newline = true
29+
trim_trailing_whitespace = true
30+
indent_size = 2
31+
indent_style = space

‎.gitattributes

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# newlines
2+
* text=auto eol=lf
3+
4+
*.xml text eol=lf
5+
*.abap text eol=lf
6+
*.md text eol=lf
7+
*.txt text eol=lf
8+
*.yml text eol=lf
9+
*.yaml text eol=lf
10+
*.js text eol=lf
11+
*.json text eol=lf
12+
*.html text eol=lf
13+
*.css text eol=lf
14+
*.svg text eol=lf
15+
*.sh text eol=lf
16+
17+
*.jpg binary
18+
*.gif binary
19+
*.png binary
20+
*.jpeg binary

‎.github/workflows/reuse.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: REUSE Compliance Check
2+
3+
on: [push, pull_request,workflow_dispatch]
4+
5+
jobs:
6+
test:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- name: REUSE Compliance Check
11+
uses: fsfe/reuse-action@v1

‎.reuse/dep5

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
Upstream-Name: ...
3+
Upstream-Contact: Marc Bernard <[email protected]>
4+
Source: https://github.com/abapPM/ABAP-...
5+
6+
Files: *
7+
Copyright: 2024 apm.to Inc. <https://apm.to>
8+
License: MIT

‎CHANGELOG.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
7+
and [ISO Date Format](https://www.iso.org/iso-8601-date-and-time-format.html).
8+
9+
## [Unreleased]
10+
11+
### Added
12+
13+
### Changed
14+
15+
### Fixed
16+
17+
18+
## Version [1.0.0] - 2022-01-01
19+
20+
Initial Release.
21+
22+
23+
[Unreleased]: https://github.com/abapPM/ABAP-.../compare/1.0.0...main
24+
[1.0.0]: https://github.com/abapPM/ABAP-.../releases/tag/1.0.0

‎CONTRIBUTING.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to apm
2+
3+
apm welcomes your suggestions and contributions! Before opening your first issue or pull request, please review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand how our community interacts in an inclusive and respectful manner.
4+
5+
## General Advice
6+
7+
* If you're new and want to help out, see if there are "good first issues" listed [here](../../issues). They should not be complicated to implement but require you to get the project up and running. Or pick something that annoys you. Fix a typo. Improve an error message. Or try something unusual just to see if it works and if it doesn't, open an issue.
8+
9+
* Before starting any significant development, open an issue and propose your solution first. A discussion can save a lot of unnecessary work. It also helps others know that this is being worked on.
10+
11+
* It is in your best interest to keep the commits/PRs as small as possible and solve one thing at a time. The smaller your change is, the easier it is to review and it will be more likely to get accepted.
12+
13+
* Commit often, whenever something is working, and is a step in the right direction do a commit or PR. This way other contributors can see the changes, and it will minimize the risk of merge conflicts.
14+
15+
* If you don't have the time or knowledge to fix the problem yourself, you can still make it move along faster by providing an accurate description or a repo that reproduces the issue.
16+
17+
## Bug Reports
18+
19+
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
20+
21+
Guidelines for bug reports:
22+
23+
1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.
24+
25+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest version or development branch in the repository.
26+
27+
3. **Demonstrate the problem** &mdash; provide clear steps that can be reproduced.
28+
29+
A good bug report should not leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help to fix any potential bugs.
30+
31+
## Development Guidelines
32+
33+
### Compatibility
34+
35+
apm is targeted for SAP Basis 7.40 and higher, so the code should only contain expressions and statements that work on 7.40. abaplint will automatically check every pull request for language syntax that is not available on these releases.
36+
37+
### Linting
38+
39+
Pull requests are checked using [abaplint](https://abaplint.org) and must pass all configured [checks](../../abaplint.json) before they can be merged.
40+
41+
### Pretty Printer
42+
43+
Use pretty printer, keywords upper case + indentation.
44+
45+
### Prefixing
46+
47+
Variables are prefixed using the standard setting in [abapOpenChecks](http://docs.abapopenchecks.org/checks/69/) naming conventions.
48+
49+
### Internationalization (I18N)
50+
51+
Currently, apm supports only the English language. Neither objects nor text literals are translated. Therefore, all objects shall be set to English as the original language. Text literals in the code shall be maintained in English.
52+
53+
## Contribution Licensing
54+
55+
Most of our code is distributed under the terms of the [license](LICENSE), and when you contribute code that you wrote to our repositories, you agree that you are contributing under those same terms. In addition, by submitting your contributions you are indicating that you have the right to submit those contributions under those terms.
56+
57+
If you wish to contribute code or documentation *authored by others* or use the terms of any other license, please indicate that clearly in your pull request so that the project team can discuss the situation with you.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright 2024 apm.to Inc. <https://apm.to>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎LICENSES/MIT.txt

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The MIT License (MIT)
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
![Version](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/abapPM/ABAP-XXX/src/zcl_XXX.clas.abap/c_version&label=Version&color=blue)
2+
3+
[![License](https://img.shields.io/github/license/abapPM/ABAP-XXX?label=License&color=success)](https://github.com/abapPM/ABAP-XXX/blob/main/LICENSE)
4+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?color=success)](https://github.com/abapPM/.github/blob/main/CODE_OF_CONDUCT.md)
5+
[![REUSE Status](https://api.reuse.software/badge/github.com/abapPM/ABAP-XXX)](https://api.reuse.software/info/github.com/abapPM/ABAP-XXX)
6+
7+
# XXX
8+
9+
10+
11+
NO WARRANTIES, [MIT License](https://github.com/abapPM/ABAP-XXX/blob/main/LICENSE)
12+
13+
## Usage
14+
15+
...
16+
17+
## Prerequisites
18+
19+
SAP Basis 7.40 or higher
20+
21+
## Installation
22+
23+
Import ABAP XXX to your project using [apm](https://abappm.com).
24+
25+
```abap
26+
IMPORT '*' TO 'z$1_your_project$2' FROM 'xxx'.
27+
" or
28+
IMPORT '*' TO '/namespace/$1$2' FROM 'xxx'.
29+
```
30+
31+
## Contributions
32+
33+
All contributions are welcome! Read our [Contribution Guidelines](https://github.com/abapPM/ABAP-XXX/blob/main/CONTRIBUTING.md), fork this repo, and create a pull request.
34+
35+
You can install the developer version of ABAP XXX using [abapGit](https://github.com/abapGit/abapGit) either by creating a new online repository for https://github.com/abapPM/ABAP-XXX.
36+
37+
Recommended SAP package: `$XXX`
38+
39+
## About
40+
41+
Made with ❤️ in Canada
42+
43+
Copyright 2024 apm.to Inc. <https://apm.to>
44+
45+
Follow [@marcfbe](https://twitter.com/marcfbe) on X/Twitter or [marcfbe](https://linkedin.com/in/marcfbe) or LinkedIn

0 commit comments

Comments
 (0)