github
/
acme.sh
mirror of https://github.com/acmesh-official/acme.sh
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Code of conduct (markdown)

master
neil 2022-08-20 12:36:39 +08:00
parent 42167c0ff7
commit eb53f4f8e5
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Code-of-conduct.md

@ -24,5 +24,25 @@ And please watch to that issue. Any future bug will be reported there.
Example: https://github.com/Neilpang/acme.sh/issues/2057
### 3. Cross-Platform Compatibility Guide
1. Don't use `grep -o` options, please use `_egrep_o()` function instead, other grep options may be used with caution.
2. Don't use `curl` or `wget`, please use `_get()` or `_post()` function instead. The `_post()` function can send `POST`, `PUT` or `UPDATE` requests.
3. Do not use `sed -e`, which causes a problem in OS X and BSD.
4. Do not use `sed` with labels, which causes `Label too long` problem in Solaris.
5. Do not use `sed` with newlines (`\n`), which causes a problem in OS X and BSD.
6. Do not use `grep -E` option.
If you need a BSD or Solaris development environment, please head to [vmactions](https://github.com/vmactions). For example, you can use [solaris-shell](https://github.com/vmactions/shell-solaris) to get a shell environment in Solaris.
## Style Guidelines
acme.sh uses shellcheck for new commits and also enforces style guidelines.
To avoid the most common travis failures:
* Use indentation with 2 spaces
* remove trailing spaces
* Doublequote variables (use _debug txtvalue "$txtvalue" instead of _debug txtvalue=$txtvalue)
* Always check the travis results after a commit
* Consider using shellcheck (https://www.shellcheck.net/) before commiting