Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

35 lines (19 loc) · 3.37 KB

How to contibute to YetiForce?

First of all - THANK YOU❤ for taking the time to contribute to our project. We appreciate your effort and willingness to help us make YetiForce even better. If you want to contribute to YetiForce even if have no (or little) programming knowledge don’t worry, you can still help us out big time! Here’s how:

👍TRANSLATE the system

We are always looking for people who would like to help us translate YetiForce to different languages in order to be able to reach people all over the world. We as a company only take care of the English and Polish translations of the system, all the other languages are maintained by our wonderful community. Adding and updating translations in YetiForce is very simple and doesn’t require any programming knowledge thanks to Crowdin. This guide explains how to add new translations.

👍TEST the system

Help us find all the bugs in the developer version of our system - gitdeveloper. We add changes to the this version several times per day and sometimes some bugs manage to sneak in as well, so testers are always most welcome and appreciated. Once you do find a bug you should definitely ↓

👍REPORT issues

We can only fix the issues that we know of, so whenever you spot a bug, please let us know. If you find a bug on your own instance, please test whether it also exists on our testing version. We prepared several different issue templates for you to choose depending on what you want to report. The templates will guide you through the reporting process so please fill them in carefully and give us as much information as possible. Issues that don't provide enough information and can't be reproduced will be closed. Additionally, before you submit an issue, search the open and closed tickets at GitHub. Someone might have already reported this or a similar problem, so you will have a ready solution.

IMPORTANT: Please report only one problem in one issue, it makes it easier for us to keep track of all the issues we still need to fix. Thank you!

If you are a developer or programming is your hobby and you’d like to send us your code, this is how you can do it:

👍PULL REQUESTS

If you want to send us a fix, patch, functionality or any other code you wrote you can send us a pull request. We will review it and either merge it or let you know what to fix. There is a template for pull requests so please read it and fill it before submitting it to us. In our company, we follow certain coding rules and make sure our code complies with the current standards. We have a special folder where you can find the most important coding guides in Polish and English. Please get familiar with the rules before you send a pull request.

If you are an advanced user of our system and would like to write and send us an article to add to our documentation, that’s the way to go:

👍DOCUMENTATION articles

If you wrote an article or a guide that explains the system’s functionalities that you would like to share with the community, you can send your article to us ([email protected]). We will review it and add it to the proper section in our documentation. We will of course give you credit for your work.