From 849432a9e917189bda576f5258b78fd2d2c347b1 Mon Sep 17 00:00:00 2001 From: Erich Date: Sat, 20 Dec 2025 10:36:14 +1000 Subject: [PATCH] Enhance CONTRIBUTING.md with PR guidelines Added guidelines for PR compliance and documentation updates. --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 856c32c8903..281771ceca6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,6 +64,12 @@ docker build -t cecli -f docker/Dockerfile . ## Coding Standards +It really helps the merge process if your PR: + +1. complies with project coding standards +2. includes test coverage +3. updates the relevant user-facing documentation, including the output of `/help` and `--help` as well as notes in config files and the web-site. + ### Python Compatibility Aider supports Python versions 3.9, 3.10, 3.11, and 3.12. When contributing code, ensure compatibility with these supported Python versions. @@ -152,4 +158,4 @@ The project's documentation is built using Jekyll and hosted on GitHub Pages. To bundle exec jekyll serve ``` -The built documentation will be available in the `aider/website/_site` directory. \ No newline at end of file +The built documentation will be available in the `aider/website/_site` directory.