Contribute

Here are some tips when you want to contribute to PVSnesLib and commit code to be reviewed

Master branch is forbidden !

Do not push your pull request on master branch, always use the develop one

AI-assisted contribution

AI-generated code or documentation (ChatGPT, Claude, Copilot, etc.) may be used, but must be reviewed, understood, and tested by the contributor before submission. The contributor is responsible for the final code, to ensure accuracy and copyright integrity.

Important

Pull Requests containing unreviewed or incorrect AI-generated code may be rejected.

Good things in small packages

Submit one feature or one bug fix per Pull Request. Small PRs are easier to review and merge.

Guidance

1. Performance: Changes may be rejected if they cause a drop in maximum FPS.
2. Usefulness: Changes and features may not be accepted if we determine they're not useful enough or they are out of scope.
3. Documented: New APIs or major features should include or update an example demonstrating their usage. Update the documentation whenever you change or add a public API.

Note

Pull requests may be rejected for a variety of reasons, even if they are functional. Please consult with the team before making any significant changes.

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.
Format: <type>(<scope>): <subject> <scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

• feat: (new feature for the user, not a new feature for build script)
• fix: (bug fix for the user, not a fix to a build script)
• docs: (changes to the documentation)
• style: (formatting, missing semi colons, etc; no production code change)
• refactor: (refactoring production code, eg. renaming a variable)
• test: (adding missing tests, refactoring tests; no production code change)
• chore: (updating grunt tasks etc; no production code change)

References:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html

Wiki

If you want to help us to maintain the wiki or create new sections, you can do it by pull request too.

To do it, just clone the repository then update pages in the wiki folder.
When the pull request will be approved, it will be automatically synchronized with the content available here.

The Wiki pages use the Markdown syntax, we recommend you to use Visual Studio Code to update it as you can see the result directly in the tool by using the shortcut Ctrl+Shift+V or by clicking on the icon available in the top right corner of the window.