Update contributing.md to improve new contributor experience, add AI disclosure requirement. #8294
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ipse info from README
sovdeeth
added
the
github related
erenkarakal
approved these changes
Nov 23, 2025
Member
erenkarakal
left a comment
erenkarakal
left a comment
There was a problem hiding this comment.
requested changes are up to you
skriptlang-automation
bot
added
the
needs reviews
sovdeeth
commented
Nov 23, 2025
Co-authored-by: Eren <67760502+erenkarakal@users.noreply.github.com>
github-project-automation
bot
moved this from In Review
to Awaiting Merge
in 2.13 Releases
skriptlang-automation
bot
added
patch-ready
github-project-automation
bot
moved this from Awaiting Merge
to Done - Awaiting Release
in 2.13 Releases
skriptlang-automation
bot
added
completed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Our contributing.md file is rather outdated and misses a lot of useful information for first time contributors. This PR aims to add more information on our git setup, namely about what branches to base on (a common mistake for first time contributors) and how to build and run tests.
In addition, we have recently had a spate of new contributors who either primarily use AI to write their code, write their messages, or both. Knowing what was made by AI would help us understand issues in contributions and help guide new contributors to write more accurate code for the Skript project.
Solution
contributing.md has been edited and reworked to cut out a lot of extraneous text and provide more actionable examples for new users. I added some example git commands to provide a stepping stone for contributors unfamiliar with git, and I welcome any other suggestions for pain points.
This PR also adds a requirement to disclose AI usage when making contributions, and adds a field to the PR template for this purpose.
Any other suggestions for improving the contributing file are very welcome.
Testing Completed
N/A
Supporting Information
Thanks to biomejs, who gave me the idea for the AI disclosure requirement and from whom I pulled the base test for the disclosure section.
Completes: none
Related: none
AI assistance: GitHub Copilot was active and helped complete some lines. All generated content was edited to ensure it was correct and fit the voice I desired.