mirror of
https://github.com/abapGit/abapGit.git
synced 2025-04-30 11:46:38 +08:00
998d89b314
* link to the section in docs.abapgit.org https://github.com/larshp/abapGit/issues/1402 * add doc page contributing to abapGit https://github.com/larshp/abapGit/issues/1402 * Contributing to abapGit section other https://github.com/larshp/abapGit/issues/1402 * moved to others https://github.com/larshp/abapGit/issues/1402 * link changed to section other https://github.com/larshp/abapGit/issues/1402
37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
## 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** — check if the issue has already been
|
|
reported.
|
|
|
|
2. **Check if the issue has been fixed** — try to reproduce it using the
|
|
latest `master` or development branch in the repository.
|
|
|
|
3. **Demonstrate the problem** — 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
|
|
|
|
a. Make sure there is an open issue for the stuff that you want to work on. When starting the development add a comment in the issue. This will allow for discussing possible solutions, and avoid having multiple people look into the same issue.
|
|
|
|
b. Keep the commits/PR as small as possible, try not to fix multiple issues in one commit/PR if possible. Smaller changes are easier to review, and are more likely to be accepted.
|
|
|
|
c. Variables are prefixed using the standard setting in Code Inspector check "Extended Naming Conventions for Programs"
|
|
|
|
d. abapGit is targeted for version 702, so the code should only contain expressions/statements that works on 702
|
|
|
|
e. 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.
|
|
|
|
f. Use pretty printer, keywords upper case + indentation
|
|
|
|
External Links:
|
|
https://guides.github.com/activities/contributing-to-open-source/
|
|
|
|
## Building/Creating a PR
|
|
|
|
Building/Creating a PR is described here: http://docs.abapgit.org/other-contributing-abapGit.html
|