PixiEditor/CONTRIBUTING.md

Contributing

Hey! Thanks for being interested in contributing to the PixiEditor! Please read below guide before continuing.

Overview

PixiEditor consists of a few sub-projects:

• ColorPicker - UI component for picking colors and gradients.
• Drawie - Core rendering library
• PixiDocks - Docking and layout manager for Avalonia
• PixiParser - Parser for .pixi files

Before making any changes to files that are part of above, remember that these are standalone, PixiEditor independed libraries and shouldn't contain code strictly related to PixiEditor codebase.

Where to start?

PixiEditor codebase is big, it might be a little intimidating to start. Make sure to start with little tasks first and get slowly familiar with it. The very first place to look at is Issues, find issues with good first issue labels. Each issue should contain a description or comments with tips on what files to look at.

And if you're stuck, don't hesitate to join our Discord. We are more than happy to guide you and help.

It is also a good practice to comment on the issue that you want to work on it, we'll assign the issue to you. Generally, you should take the issues with up-for-grabs label, it basically means that core development team doesn't plan to work on them anytime soon. If the issue is assigned to someone, ask in the comments if the person is actively working on it, and if not you might be assigned.

Do not make undiscussed features!

It is very important to discuss any new features with PixiEditor's development team. This is just to ensure that your work and our time won't be wasted, it is perfectly sufficient to create an issue on GitHub or even ask on Discord or Forum with brief description of what you want to do.