diff options
| author |  BanceDev
| 2024-09-04 19:04:13 -0400 |
|---|---|---|
| committer | BanceDev
| 2024-09-04 19:04:13 -0400 |
| commit | 99b8bb5f5a5df3cc28d2f944a8f9655e6ef01684 (patch) | |
| tree | 9ccfc3e89eafc826e97a8bf18754565b2fdf4a8b /CONTRIBUTING.md | |
| parent | Create CONTRIBUTING.md (diff) | |
upadted contribution guidelines
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f15aab..08b4f02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,3 +44,21 @@ void draw(); - Use sized operations as often as possible to avoid buffer overflows ex: strncpy vs strcpy ## PR Guidelines + +When opening a pull request ensure that your PR is limited in scope to a singular change, fix, or feature. Also make sure it includes the following + +- A detailed description of what your changes include +- If a new function is added to the Lua API also include demo code in the example.lua file showing its use +- If you can, attach a screenshot demonstrating your change + +PR's will be reviewed by one of the maintainers. If they request changes, please make them or the PR will not be able to be accepted. + +## Issue Guidelines + +When opening an issue please follow a similar format to PRs + +- A detailed description of what your issue is +- If it is a bug include steps to recreate the issue +- If the issue is asking for a new lua API method, show an example of its intended use if you can +- If you can, attach a screenshot showing your issue + |