Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Establish guidelines for usage of AI in PRs #11940

Merged
merged 10 commits into from
Oct 14, 2024
Merged

Establish guidelines for usage of AI in PRs #11940

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
63d1241
Add check for AI-generated PRs
subhramit Oct 12, 2024
8d0073d
Refine
subhramit Oct 12, 2024
dc68abb
Add to greeting
subhramit Oct 12, 2024
1317081
Remove reference to code of conduct
subhramit Oct 12, 2024
7434a06
Change mandatory check
subhramit Oct 14, 2024
5be3612
Refine condition
koppor Oct 14, 2024
ce16be4
Discard changes to .github/workflows/add-greeting-to-issue.yml
koppor Oct 14, 2024
7d3ae16
Merge branch 'main' into checks
koppor Oct 14, 2024
be673d2
Update CONTRIBUTING.md
koppor Oct 14, 2024
0885afa
Update PULL_REQUEST_TEMPLATE.md
koppor Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Don't reference an issue in the PR title because GitHub does not support auto-li
- [ ] Change in `CHANGELOG.md` described in a way that is understandable for the average user (if applicable)
- [ ] Tests created for changes (if applicable)
- [ ] Manually tested changed features in running JabRef (always required)
- [ ] The PR contains no or minimal AI-generated code (If any present, it is trivial and I fully understand it)
Copy link
Member

@InAnYan InAnYan Oct 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

What I don't like about this topic is "AI usage" == bad, which has nothing to do with goodness/effectiveness.

I like that you didn't wrote it like in that SUSE project, where no AI code is allowed (if we were to discuss this topic, then that will be too much philosophy). And because JabRef is used for teaching, we definitely need a section on AI.

But I'm not sure about that additional check. I think this is + mind effort to click that, + mind effort to think "I used copilot, is it ok or not...", "It's small, it's okay...", "No it's big, what should I do"...

I think it's best to populate some documentation page about that, where you could tell more how to use AI correctly.

Yes! I think the idea should be "the correct usage of AI" but not "disallowance of AI" or "to which extent you should use AI".

Copy link
Member Author

@subhramit subhramit Oct 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Good points, and I agree.
Yes, the usage of AI is not "bad" (we all use it), except that a new contributor can get away with a PR addressing a good first issue merged, having learnt absolutely nothing as well as taking away the opportunity from someone who would want to work on it (and not just get a PR merged).

In case of effectiveness, we can use the same argument, pass every good first issue through AI, have them solved with minimal effort and not wait for the students to do it.

Effective use of AI and the extent - yes, I like this idea too! Feel free to co-author this PR, change any text that you feel fit (or add to documentation/contributing guidelines).

Copy link
Member Author

@subhramit subhramit Oct 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@InAnYan Discussion: How does this sound:
"I fully understand the working of any code in this PR picked up from any external source/generated using AI."

- [ ] Screenshots added in PR description (for UI changes)
- [ ] [Checked developer's documentation](https://devdocs.jabref.org/): Is the information available and up to date? If not, I outlined it in this pull request.
- [ ] [Checked documentation](https://docs.jabref.org/): 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 to the documentation repository.
2 changes: 2 additions & 0 deletions .github/workflows/add-greeting-to-issue.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ jobs:

Newcomers, we're excited to have you on board. Start by exploring our [Contributing](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md) guidelines, and don't forget to check out our [workspace setup guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace) to get started smoothly.

Copy link
Member

Choose a reason for hiding this comment

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

we currently habe no formal code of conduct... not sure if we should invest time to create one...

We request you to adhere to the project's code of conduct and go through the mandatory checks mentioned when you submit a PR once you have solved the issue.

In case you encounter failing tests during development, please check our [developer FAQs](https://devdocs.jabref.org/code-howtos/faq.html)!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on [JabRef's Gitter chat](https://gitter.im/JabRef/jabref). And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.
Expand Down
Loading