Contribute guide

Start Contribute

This guide is intended for new contributors. It teaches you the basics of project participation. By contributing, you can improve the project and use better versions of it in your applications. If you are a user reading this page, you can contribute to the bug report by posting a topic. See here for Types of contributions.

Wiki

In SLib, wikis are places used to maintain online documents, you can contribute to the project by developing them, but be sure to create an issue with a wiki tag before making changes.

Godot Documentation

One of the ways to develop the project is to expand its offline documentation that can be used internally in Godot, you can modify them by creating Pull Requests or sending issues with the documentation tag.

File Cleanup

One of the problems of the SLib project is the problems in Git, if you can optimize them, you can send an issue or pull request with the Git tag.

Welcome to new users

New members need guidance, if you have enough experience with SLib you can help them, the best way is to look for issues taged "I am new". You can invite new users to SLib to join our community. You can also modify the direction of new users.

License

If you come across an undefined issue with licenses, you can report it with an issue with the license tag.

Security Support

Simple security tests are automatically performed on SLib, but you can perform additional tests and submit them with the security tag.

C# Support

SLib is currently only available for GDScript, but to improve the code quality of all Godot users, which is the ultimate goal of SLib, we also need a C# version of it. If you are able to understand C# and GDScript at the same time, you can develop Help us with its C# version.

Submit Issues

Issues are one of the best ways to get involved:

• bug
• contribute
• documentation
• duplicate
• education
• enhancement
• general
• git
• good first issue
• help wanted
• I am new
• installation
• invalid
• license
• question
• security
• wiki
• wontfix

Discussions

Discussions are a place for interaction in the SLib community, you can contribute to the development of the project by participating in the discussions.

Teach

If you have enough experience and knowledge in SLib, you can help the project by teaching newbies.

Translations

If you have translation skills, you can translate the documentation to help globalize SLib.

Animations

You can add new animations or improve current animations for SLib Animation System.

Parallel development

Basic setup

These steps will help you setup with Godot and Github to start contributing your changes to this repository

1. Download Godot from their website or from steam.
2. Create a Github account if you do not already have one
3. Install git for a command line interface or Github desktop for a graphical interface (recommended).
4. Fork this repositoy. See this guide if you use git or this guide if you use Github desktop (recommended)
5. Clone your fork to your local computer if you haven't already. You can now launch Godot and open the project. If you're new to Godot, read their getting started guide.

Make your changes

These steps show you how to make a simple change to the library

1. Before you can start making changes, make a branch using git or Github Desktop (recommended)
2. Open the project in Godot if you haven't already
3. Open Slib.gd file.
4. Create, edit or erase codes.
5. For test, use _ready function and create it in top of functions, write your function name and parameters and use F5.
6. If you need better test, install your library in a new godot project and use it. How To Install?
7. Write documentation in top of edited code, see here for description.
8. Remove _ready function and save file.
9. To commit your changes to your branch, read this guide for Github Desktop (recommended) or this guide for git
10. Lastly, create a pull request.