mirror of
https://github.com/abapGit/abapGit.git
synced 2025-04-29 19:26:29 +08:00
docs: move on development
This commit is contained in:
parent
b7c045210b
commit
2d108246fb
|
@ -16,21 +16,8 @@ A good bug report should not leave others needing to chase you up for more infor
|
|||
|
||||
## 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/
|
||||
http://docs.abapgit.org/development/guidelines.html
|
||||
|
||||
## Building/Creating a PR
|
||||
|
||||
Building/Creating a PR is described here: http://docs.abapgit.org/other-contributing-abapGit.html
|
||||
http://docs.abapgit.org/development/contributing.html
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Contributing to abapGit
|
||||
order: 90
|
||||
title: Contributing
|
||||
order: 5
|
||||
---
|
||||
|
||||
*******************************
|
||||
|
@ -15,6 +15,6 @@ order: 90
|
|||
|
||||
5: After the pull request is merged, abapmerge will automatically run to build the report version of abapGit.
|
||||
|
||||
Every time a commit is pushed to the master branch, https://travis-ci.org/ will be triggered to perform the build. It will use [abapmerge](https://github.com/larshp/abapmerge) to merge all the includes into a single file, the build can be downloaded from https://raw.githubusercontent.com/abapGit/build/master/zabapgit.abap
|
||||
Every time a commit is pushed to the master branch, [Travis CI](https://travis-ci.org/) will be triggered to perform the build. It will use [abapmerge](https://github.com/larshp/abapmerge) to merge all the includes into a single file, the build can be downloaded from [https://raw.githubusercontent.com/abapGit/build/master/zabapgit.abap](https://raw.githubusercontent.com/abapGit/build/master/zabapgit.abap)
|
||||
|
||||
Alternatively, use the GitHub webinterface to change the files and submit a pull request.
|
||||
|
|
|
@ -1,11 +1,10 @@
|
|||
---
|
||||
title: docs
|
||||
order: 10
|
||||
order: 200
|
||||
---
|
||||
|
||||
abapGit uses github pages for documentation, https://help.github.com/articles/what-is-github-pages/
|
||||
|
||||
All pages are generated statically using https://jekyllrb.com/
|
||||
abapGit uses [github pages](https://help.github.com/articles/what-is-github-pages/) for documentation,
|
||||
all pages are generated statically using [Jekyll](https://jekyllrb.com/)
|
||||
|
||||
Building /docs/ locally:
|
||||
|
||||
|
|
27
docs/collections/_development/guidelines.md
Normal file
27
docs/collections/_development/guidelines.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: Development Guidelines
|
||||
order: 10
|
||||
---
|
||||
|
||||
### Practical
|
||||
|
||||
* 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.
|
||||
|
||||
* 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.
|
||||
|
||||
* 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.
|
||||
|
||||
External Links:
|
||||
[https://guides.github.com/activities/contributing-to-open-source/](https://guides.github.com/activities/contributing-to-open-source/)
|
||||
|
||||
### Conventions
|
||||
|
||||
#### Prefixing
|
||||
Variables are prefixed using the standard setting in [abapOpenChecks Naming Conventions](http://docs.abapopenchecks.org/checks/69/)
|
||||
|
||||
#### Downport
|
||||
abapGit is targeted for version 702, so the code should only contain expressions/statements that works on 702.
|
||||
[abaplint](https://abaplint.org) will automatically check every PR for language syntax that is not available on 702.
|
||||
|
||||
#### Pretty Printer
|
||||
Use pretty printer, keywords upper case + indentation, [abapOpenChecks](http://docs.abapopenchecks.org/checks/06/) can be used for checking this
|
7
docs/collections/_development/tests.md
Normal file
7
docs/collections/_development/tests.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Unit Tests
|
||||
order: 70
|
||||
---
|
||||
|
||||
* Todo: Describe dependency lookup approach
|
||||
* Todo: describe dangerous flag
|
Loading…
Reference in New Issue
Block a user