Contribution Guide

Bug Reports

To encourage active collaboration, Karee strongly encourages pull requests, not just bug reports..

However, if you find a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem. If you want to chip in, you can help out by fixing any bugs listed in our issue trackers. You must be authenticated with GitHub to view all of Karee's issues.

The Karee source code is managed on GitHub, and there are repositories for each of the Karee projects:

Karee CLI
Karee Lib
Karee Documentation
Karee Website

You can also contribute to this project by

• Writing Articles around Karee
• Making videos / tutorials to help other to learn
• Suggesting Karee as useful alternative for Flutter development
• Providing More translation of ReadME and Documentation for unsupported languages
• Adding the tag #Karee on Medium, Twitter, Dev Community, LinkedIn, Zouktil
• Giving Stars on this repo
• Forking the repo

Support Questions

Karee's GitHub issue trackers are not intended to provide Karee help or support. Instead, use one of the following channels:

GitHub Discussions
StackOverflow
Karee Discord Server
flutter.bixterprise.com Forums

Core Development Discussion

You may propose new features or improvements of existing Karee behavior in the Karee Ideas issue board. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.

Informal discussion regarding bugs, new features, and implementation of existing features takes place in the #internals channel of the Karee Discord Server. Champlain Marius, the maintainer of Karee, is typically present in the channel on weekdays from 8am-5pm GMT +1 Paris, and sporadically present in the channel at other times.

Which Branch?

All bug fixes should be sent to the latest stable branch or to the current LTS branch. Bug fixes should never be sent to the master branch unless they fix features that exist only in the upcoming release.

Minor features that are fully backward compatible with the current release may be sent to the latest stable branch.

Major new features should always be sent to the master branch, which contains the upcoming release.

If you are unsure if your feature qualifies as a major or minor, please ask Champlain Marius in the #internals channel of the Karee Discord.

Code of Conduct

The Karee code of conduct is listed. Any violations of the code of conduct may be reported to Champlain Marius (bncmarius@hotmail.com):

• Participants will be tolerant of opposing views.
• Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
• When interpreting the words and actions of others, participants should always assume good intentions.
• Behavior that can be reasonably considered harassment will not be tolerated.
• Respect people, their identities, their culture, and their work.
• Be kind. Be courteous. Be welcoming.
• Listen. Consider and acknowledge people’s points before responding.