You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,10 @@
1
-
## General advice
1
+
#Contributing to Marc Bernard Tools
2
2
3
-
* If you're new and want to help out, see if there are "good first issues" listed. 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.
3
+
Marc Bernard Tools 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.
4
8
5
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.
6
10
@@ -26,22 +30,28 @@ A good bug report should not leave others needing to chase you up for more infor
26
30
27
31
## Development Guidelines
28
32
29
-
### Prefixing
33
+
### Compatibility
30
34
31
-
Variables are prefixed using the standard setting in [abapOpenChecks](http://docs.abapopenchecks.org/checks/69/) naming conventions.
35
+
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.
32
36
33
-
### Downport
37
+
### Linting
34
38
35
-
The project is targeted for SAP Basis 7.02 and higher, so the code should only contain expressions/statements that works on 7.02. abaplint will automatically check every PR for language syntax that is not available on these releases.
39
+
Pull requests are checked using [abaplint](https://abaplint.org) and must pass all configured [checks](../../abaplint.json) before they can be merged.
36
40
37
41
### Pretty Printer
38
42
39
43
Use pretty printer, keywords upper case + indentation.
40
44
41
-
### abaplint
45
+
### Prefixing
42
46
43
-
Pull requests must pass all abaplint checks before they can be merged.
47
+
Variables are prefixed using the standard setting in [abapOpenChecks](http://docs.abapopenchecks.org/checks/69/) naming conventions.
44
48
45
49
### Internationalization (I18N)
46
50
47
-
Currently, the project supports 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.
51
+
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.
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 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.
0 commit comments