Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mbtools authored Dec 13, 2023
0 parents commit fd3ec0e
Show file tree
Hide file tree
Showing 11 changed files with 2,664 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .abapgit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8"?>
<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
<asx:values>
<DATA>
<MASTER_LANGUAGE>E</MASTER_LANGUAGE>
<STARTING_FOLDER>/src/</STARTING_FOLDER>
<FOLDER_LOGIC>PREFIX</FOLDER_LOGIC>
<REQUIREMENTS>
<item>
<COMPONENT>SAP_BASIS</COMPONENT>
<MIN_RELEASE>731</MIN_RELEASE>
</item>
</REQUIREMENTS>
<PACKAGING>
<NAME>mbt-xxx</NAME>
<VERSION>1.0.0</VERSION>
<DESCRIPTION>XXX</DESCRIPTION>
<TARGET_PACKAGE>/MBTOOLS/BC-XXX</TARGET_PACKAGE>
<LOGO>/MBTOOLS/MBT_XXX_TN</LOGO>
<DEPENDENCIES>
<item>
<NAME>mbt-base</NAME>
<VERSION>1.4.0</VERSION>
</item>
</DEPENDENCIES>
</PACKAGING>
</DATA>
</asx:values>
</asx:abap>
31 changes: 31 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# 1 space indentation for xml files
[*.xml]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 1

# match the format used by abapGit
[*.{abap,js,json,html,css}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_size = 2
indent_style = space

# YAML and Bash Files
[*.{yml,yaml,sh}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_size = 2
indent_style = space
20 changes: 20 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# newlines
* text=auto eol=lf

*.xml text eol=lf
*.abap text eol=lf
*.md text eol=lf
*.txt text eol=lf
*.yml text eol=lf
*.yaml text eol=lf
*.js text eol=lf
*.json text eol=lf
*.html text eol=lf
*.css text eol=lf
*.svg text eol=lf
*.sh text eol=lf

*.jpg binary
*.gif binary
*.png binary
*.jpeg binary
11 changes: 11 additions & 0 deletions .github/workflows/reuse.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: REUSE Compliance Check

on: [push, pull_request,workflow_dispatch]

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: REUSE Compliance Check
uses: fsfe/reuse-action@v1
8 changes: 8 additions & 0 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: Marc Bernard Tools - XXX
Upstream-Contact: Marc Bernard <[email protected]>
Source: https://github.com/Marc-Bernard-Tools/MBT-XXX

Files: *
Copyright: 2023 Marc Bernard <https://marcbernardtools.com/>
License: GPL-3.0-only
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
and [ISO Date Format](https://www.iso.org/iso-8601-date-and-time-format.html).

## [Unreleased]

### Added

### Changed

### Fixed


## Version [1.2.0] - 2021-12-08

Public Release

## Version [1.1.0] - 2021-04-13

Launch Release

## Version [1.0.0] - 2021-03-16

Initial Release. For details, see [Features](https://marcbernardtools.com/docs/mbt-xxx/features).


[Unreleased]: https://github.com/Marc-Bernard-Tools/MBT-XXX/compare/1.2.0...main
[1.2.0]: https://github.com/Marc-Bernard-Tools/MBT-XXX/compare/1.1.0...1.2.0
[1.1.0]: https://github.com/Marc-Bernard-Tools/MBT-XXX/compare/1.0.0...1.1.0
[1.0.0]: https://github.com/Marc-Bernard-Tools/MBT-XXX/releases/tag/1.0.0
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing to Marc Bernard Tools

Marc Bernard Tools welcomes your suggestions and contributions! Before opening your first issue or pull request, please review our [Code of Conduct](https://github.com/Marc-Bernard-Tools/.github/blob/main/CODE_OF_CONDUCT.md) to understand how our community interacts in an inclusive and respectful manner.

## General Advice

* 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.

* 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.

* 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.

* 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.

* 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 which reproduces the issue.

## Bug Reports

A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.

2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest version or development branch in the repository.

3. **Demonstrate the problem** &mdash; provide clear steps that can be reproduced.

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.

## Development Guidelines

### Compatibility

Marc Bernard Tools are targeted for SAP Basis 7.31 and higher, so the code should only contain expressions and statements that works on 7.31. abaplint will automatically check every pull request for language syntax that is not available on these releases.

### Linting

Pull requests are checked using [abaplint](https://abaplint.org) and must pass all configured [checks](../../abaplint.json) before they can be merged.

### Pretty Printer

Use pretty printer, keywords upper case + indentation.

### Prefixing

Variables are prefixed using the standard setting in [abapOpenChecks](http://docs.abapopenchecks.org/checks/69/) naming conventions.

### Internationalization (I18N)

Currently, Marc Bernard Tools support only 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.

## Contribution Licensing

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.

If you wish to contribute code or documentation *authored by others*, or using 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.
Loading

0 comments on commit fd3ec0e

Please sign in to comment.