diff options
| author | Shlomi Fish <[email protected]> | 2018-10-30 13:04:35 +0200 |
|---|---|---|
| committer | Shlomi Fish <[email protected]> | 2018-10-30 13:04:35 +0200 |
| commit | 5d33e86c3190d37d04ac26da804db3c53218ae7e (patch) | |
| tree | 38c9899e62e2377a0c2995c5cbeddac20b742e49 | |
| parent | d679955453070af008bcd366f0e77c018d8e7682 (diff) | |
Correct some grammar in CONTRIBUTING.md .
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d5067bb9..c6c8700ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ try to follow these guidelines when you do so. * Ensure your edited codes with four spaces instead of TAB. * Please commit code to `dev` branch and we will merge into `master` branch in future. -### Some suggestion on developing +### Some suggestions for developing code for this project #### Speed up build @@ -33,11 +33,11 @@ try to follow these guidelines when you do so. #### Understand API layouts -* Action scripts, plugin scripts and user's `xmake.lua` run in sandbox. Sandbox API is in `xmake/core/sandbox`. -* Util scripts run in base lua environment. Base API is in `xmake/core/base` -* Native API includes lua API and xmake ext API written in C in `core/src/xmake` +* Action scripts, plugin scripts and user's `xmake.lua` run in a sandbox. The sandbox API is in `xmake/core/sandbox`. +* Utility scripts run in a base lua environment. Base API is in `xmake/core/base` +* Native API, which includes the lua API and the xmake ext API, is written in C in `core/src/xmake` -For example, to copy a directory in sandbox, calling link is: `sandbox_os.cp()` -> `os.cp()` -> `xm_os_cpdir()` -> `tb_directory_copy()` +For example, to copy a directory in sandbox, the calling procedure is: `sandbox_os.cp()` -> `os.cp()` -> `xm_os_cpdir()` -> `tb_directory_copy()` ## Financial contributions |