Skip to content

Conversation

@sovdeeth
Copy link
Member

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.

@sovdeeth sovdeeth added the github related Issues or Pull requests that affect the GitHub organization/repositories label Nov 22, 2025
@sovdeeth sovdeeth requested review from a team as code owners November 22, 2025 07:27
Copy link
Member

@erenkarakal erenkarakal left a comment

Choose a reason for hiding this comment

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

requested changes are up to you

@skriptlang-automation skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Nov 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github related Issues or Pull requests that affect the GitHub organization/repositories needs reviews A PR that needs additional reviews

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants