diff options
| author | Arnold D. Robbins <arnold@skeeve.com> | 2020-02-07 09:32:41 +0200 |
|---|---|---|
| committer | Arnold D. Robbins <arnold@skeeve.com> | 2020-02-07 09:32:41 +0200 |
| commit | e9c99065fd31253a4db4a6bce673decd143f7a3e (patch) | |
| tree | 16a6669cfdb1e36dcee68322d223ffea1d5392b1 | |
| parent | e6fe674b404151c66440fd76bca7708cf3a2fe37 (diff) | |
| download | one-true-awk-e9c99065fd31253a4db4a6bce673decd143f7a3e.tar.gz | |
Update README.md PR instructions.
| -rw-r--r-- | README.md | 14 |
1 files changed, 13 insertions, 1 deletions
@@ -42,7 +42,19 @@ Thanks. ## Submitting Pull Requests -Pull requests are welcome. However, please create them with a request +Pull requests are welcome. Some guidelines: + +* Please do not use functions or facilities that are not standard (e.g., +`strlcpy()`, `fpurge()`). + +* Please run the test suite and make sure that your changes pass before +posting the pull request. To do so: + + 1. Save the previous version of `awk` somewhere in your path. Call it `nawk` (for example). + 1. Run `oldawk=nawk make check > check.out 2>&1`. + 1. Search for `BAD` or `error` in the result. In general, look over it manually to make sure there are no errors. + +* Please create the pull request with a request to merge into the `staging` branch instead of into the `master` branch. This allows us to do testing, and to make any additional edits or changes after the merge but before merging to `master`. |