Skip to content

Commit a91ce53

Browse files
authored
docs: encourage AI coding agent use in development workflow (#16)
Added prominent documentation encouraging the use of AI coding agents as valued development tools throughout the project. Changes: - Added "AI-Assisted Development" section to README with guidelines for AI-assisted contributions including review requirements, quality standards, optional transparency tagging, and security considerations - Updated CONTRIBUTING.md with concise reference to AI guidelines and key contributor responsibilities - Enhanced AICodingAgent.md header to explicitly communicate the project's positive stance on AI agent usage This addresses issue #9 by clearly communicating that AI coding agents are welcome and valued tools for problem-solving, code generation, review, and learning, while maintaining accountability for code quality and security.
1 parent 4a8fc6e commit a91ce53

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

.github/community/CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,16 @@ For a list of current backends check `aletheia_probe.backends`.
207207
- [ ] Tagged release created
208208
- [ ] PyPI package published
209209

210+
## AI-Assisted Development
211+
212+
**This project encourages the use of AI coding agents.** See the [README](../../README.md#ai-assisted-development) for guidelines.
213+
214+
Key points for contributors:
215+
- Review and test all AI-generated code thoroughly
216+
- Follow project standards in [AICodingAgent.md](../../AICodingAgent.md)
217+
- Optionally tag commits/PRs with `[AI-assisted]` for transparency
218+
- You are responsible for all submitted code
219+
210220
## Getting Help
211221

212222
### Development Questions

AICodingAgent.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
**Project:** Aletheia-Probe - Journal Assessment Tool
44
**Purpose:** Explicit instructions for AI coding assistants
55

6+
**Note:** This project actively encourages the use of AI coding agents in development. Your contributions are valued as tools to aid problem-solving, code generation, review, and learning.
7+
68
---
79

810
## 1. Before Making ANY Changes (MANDATORY)

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,25 @@ To enhance coverage with Scopus data:
237237
- [Contributing Guide](.github/community/CONTRIBUTING.md) - Development setup and guidelines
238238
- [Troubleshooting](docs/troubleshooting.md) - Common issues and solutions
239239

240+
## AI-Assisted Development
241+
242+
This project explicitly encourages and welcomes the use of AI coding agents as part of the development workflow. AI tools are valuable for:
243+
244+
- Code generation and refactoring
245+
- Writing tests and documentation
246+
- Code review and quality improvement
247+
- Problem-solving and debugging
248+
- Learning and exploring the codebase
249+
250+
**Guidelines for AI-Assisted Contributions:**
251+
252+
1. **Review and Verify**: All AI-generated code must be thoroughly reviewed, tested, and understood before submission
253+
2. **Quality Standards**: AI-assisted code must meet the same quality standards as manually written code (see [AICodingAgent.md](AICodingAgent.md))
254+
3. **Transparency**: Contributors may optionally indicate AI assistance in commit messages or PR descriptions using tags like `[AI-assisted]` for transparency
255+
4. **Responsibility**: Contributors remain fully responsible for all submitted code, regardless of how it was generated
256+
5. **Security**: Extra attention should be paid to security implications of AI-generated code
257+
258+
For detailed guidelines on using AI coding agents with this project, see [AICodingAgent.md](AICodingAgent.md).
240259

241260
## License
242261

0 commit comments

Comments
 (0)