contributing
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
contributing [2022/02/10 13:34] – external edit 127.0.0.1 | contributing [2025/03/20 12:18] (current) – jdavis | ||
---|---|---|---|
Line 120: | Line 120: | ||
It will be reviewed by other contributors to the project and will be either accepted or sent back for further work. To help ensure your patch is reviewed and committed in a timely fashion, please ensure your submission conforms to the following guidelines: | It will be reviewed by other contributors to the project and will be either accepted or sent back for further work. To help ensure your patch is reviewed and committed in a timely fashion, please ensure your submission conforms to the following guidelines: | ||
- | * Ensure that your branch or patch is developed against the most recent version of the code, which for developers is the master | + | * Ensure that your branch or patch is developed against the most recent version of the code, which for developers is the main branch in the [[http:// |
* Try to make your changes as readable as possible by following the surrounding code-layout conventions. This makes it easier for the reviewer, and there' | * Try to make your changes as readable as possible by following the surrounding code-layout conventions. This makes it easier for the reviewer, and there' | ||
* If you are submitting a patch rather than pointing at a branch in a public repository, use the Git '' | * If you are submitting a patch rather than pointing at a branch in a public repository, use the Git '' | ||
<code bash> | <code bash> | ||
- | $ git checkout -b working_branch | + | $ git checkout -b working_branch |
# hack away | # hack away | ||
Line 161: | Line 161: | ||
* Any time a patch adds or alters a stored procedure, pgTAP tests that exercise its intended functionality should be included. | * Any time a patch adds or alters a stored procedure, pgTAP tests that exercise its intended functionality should be included. | ||
* A change to database or Perl code that fixes a bug should be accompanied by a Perl (t or live_t) or pgTAP regression test – or by a statement from the patch author explaining why a test is infeasible without significant refactoring. In the latter case, it is expected that an extra signoff be obtained before the patch is merged. | * A change to database or Perl code that fixes a bug should be accompanied by a Perl (t or live_t) or pgTAP regression test – or by a statement from the patch author explaining why a test is infeasible without significant refactoring. In the latter case, it is expected that an extra signoff be obtained before the patch is merged. | ||
+ | * Changes to the Angular staff client should be run through a linter to catch inconsistencies and common errors (cd Open-ILS/ | ||
* New features should be accompanied by a file in the repository under the docs/ | * New features should be accompanied by a file in the repository under the docs/ | ||
* Bug fix patches should explain how to test the bug fix in the commit message. | * Bug fix patches should explain how to test the bug fix in the commit message. |
contributing.1644518097.txt.gz · Last modified: 2022/02/10 13:34 by 127.0.0.1