Skip to content

Add AGENTS.md and AI_USAGE_POLICY.md from p5.js#14316

Merged
koppor merged 5 commits into
mainfrom
add-agents-md
Nov 14, 2025
Merged

Add AGENTS.md and AI_USAGE_POLICY.md from p5.js#14316
koppor merged 5 commits into
mainfrom
add-agents-md

Conversation

@koppor

@koppor koppor commented Nov 14, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Triggered by #14313.

This ports processing/p5.js#8194 to here.

Semantic changes:

+We recommend AI tools trained on JabRef data, such as [DeepWiki](https://deepwiki.com/JabRef/jabref).
-- DO NOT write code for contributors.
-* CI will fail the PR if the file does not contain references to both `AGENTS.md` and `CONTRIBUTING.md` and the phrase “does not accept fully AI-generated pull requests.”

-Before asking AI, we encourage you to talk to us in the [Discord #contribute-to-p5 channel](https://discord.gg/x7kU7k5HM3) or in the relevant issue thread.
-Please know: **there are no silly questions, and we genuinely want to help you.** You won't be judged for not knowing something. In fact, we are grateful for your questions as they help us improve our documentation and make the project more welcoming for everyone who comes after you.

Steps to test

We need to see how PRs evolve.

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • [/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
  • [/] I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

InAnYan
InAnYan reviewed Nov 14, 2025
View reviewed changes
Comment thread AGENTS.md
- JSON

```json
// IMPORTANT: This project does not accept fully AI-generated pull requests.

@InAnYan InAnYan Nov 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But isn't JSON doesn't support comments?

@koppor koppor Nov 14, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://json5.org/ - haha

I think, its for AI to guide itself ^^

InAnYan
InAnYan reviewed Nov 14, 2025
View reviewed changes
Comment thread AGENTS.md
InAnYan
InAnYan reviewed Nov 14, 2025
View reviewed changes
Comment thread AGENTS.md
InAnYan
InAnYan requested changes Nov 14, 2025
View reviewed changes
Comment thread AGENTS.md Outdated
- Point them to [CONTRIBUTING.md](./CONTRIBUTING.md).
- Encourage them to read it fully before starting work.
- Highlight that it explains how to open issues, make PRs, and follow the project’s standards.
- Encourage them to **connect with the maintainers in the 🌸contribute-to-p5 channel on [Discord](https://discord.gg/x7kU7k5HM3)** for questions or feedback.

@InAnYan InAnYan Nov 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contribute-to-p5 channel - should be changed to JabRef

@github-actions github-actions Bot added the status: changes-required Pull requests that are not yet complete label Nov 14, 2025
@InAnYan

InAnYan commented Nov 14, 2025

Copy link
Copy Markdown
Member

After fully reading the PR, I now understood that this is meant to stop students excessively using AI, and it's not coding guidelines for AI coding agents.

While it's not the original purpose of AGENTS.md, I actually like the idea, since we have a lot of problematic PRs in the past

@github-actions github-actions Bot removed the status: changes-required Pull requests that are not yet complete label Nov 14, 2025
@koppor

koppor commented Nov 14, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

After fully reading the PR, I now understood that this is meant to stop students excessively using AI, and it's not coding guidelines for AI coding agents.

While it's not the original purpose of AGENTS.md, I actually like the idea, since we have a lot of problematic PRs in the past

Yeah, this is also discussed at processing/p5.js#8194 (comment):

Note that this is a non-standard use of AGENTS.md and hasn’t been tested much in practice. We're going against the grain with this one, since AI tools are strongly biased toward generating code.

@koppor koppor added the status: awaiting-second-review For non-trivial changes label Nov 14, 2025
@koppor koppor merged commit 9989fc6 into main Nov 14, 2025
65 of 66 checks passed
@koppor koppor deleted the add-agents-md branch November 14, 2025 23:40
Siedlerchr added a commit that referenced this pull request Nov 15, 2025
@Siedlerchr
Merge remote-tracking branch 'upstream/main' into dependabot/gradle/v…
128a8cf 
…ersions/org.glassfish.jersey.core-jersey-server-4.0.0

* upstream/main: (31 commits)
  Adds a 'regenerate' button to AI chat tab (#12191) (#14191)
  Chore(deps): Bump jablib/src/main/resources/csl-styles (#14323)
  Update dependency com.konghq:unirest-modules-gson to v4.6.0 (#14322)
  Convert fixed-value ComboBoxes to SearchableComboBox (#14083) (#14165)
  Add support for transliterated citation keys (#13893)
  Update dependency org.apache.maven.plugins:maven-jar-plugin to v3.5.0 (#14321)
  Add link to latest development version (#14320)
  Parameterize tests in AuthorTest and AuthorListTest (#14135)
  Add AGENTS.md and AI_USAGE_POLICY.md from p5.js (#14316)
  Fix Nullwarnings - A (#14116)
  Update io.github.darvil82:terminal-text-formatter from 2.2.0 to 2.3.0c (#14317)
  Streamline maven repositories (#14315)
  Fix paths to included Java sources
  Add forgotten ..
  Update dependency io.github.darvil82:terminal-text-formatter to v2.3.0c (#14314)
  Chore(deps): Bump io.github.classgraph:classgraph from 4.8.181 to 4.8.184 in /versions (#14304)
  Chore(deps): Bump com.fasterxml:aalto-xml in /versions (#14311)
  Chore(deps): Bump commons-io:commons-io in /versions (#14310)
  Chore(deps): Bump org.apache.maven.plugins:maven-surefire-plugin (#14298)
  Disable fetcher-gui-test (#14308)
  ...
merlinymy pushed a commit to merlinymy/jabref that referenced this pull request Nov 19, 2025
@koppor @SableRaf @merlinymy
Add AGENTS.md and AI_USAGE_POLICY.md from p5.js (JabRef#14316)
e4cc41d 
Co-authored-by: Raphaël de Courville <raphael@processingfoundation.org>
@koppor koppor mentioned this pull request Dec 17, 2025
Merged
1 task
@InAnYan InAnYan mentioned this pull request Dec 21, 2025
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@InAnYan InAnYan InAnYan approved these changes

Assignees

No one assigned

Labels

status: awaiting-second-review For non-trivial changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@koppor @InAnYan @SableRaf