Skip to content
This repository has been archived by the owner on Nov 8, 2017. It is now read-only.

Latest commit

 

History

History
41 lines (31 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 1.72 KB
Raw

Contributing

Editors like Inkscape and Adobe Illustrator tower over Mondrian in their features and abilities. While a big goal in Mondrian is to avoid feature creep and keep it visually bare, it's definitely still missing a lot. Contributors are encouraged to develop new tools and utilities they feel are missing as well as optimizing the performance of those that already exist.

All significant contributions will get credit under the "About" menu within the app.

Guidelines

  • Follow the 15 minute rule. If you can't figure something out after 15 minutes, contact Artur at [email protected] with your confusion. Make sure to be clear about what you don't understand. Help me help you!

  • Do not track new files in the /build directory unless instructed.

Ways to help

If you want to contribute, there's a lot that can be done to help move the project forward. Check the issues for bugs and feature requests, or you can pick something off of this laundry list:

  • Set up a good unit test suite with Phantomjs or another headless browser
  • Add support for missing SVG elements
    • Quadratic bezier (convert to cubic with two matching control points)
    • Elliptical arc
  • More file format import/export abilities (will probably require converter on backend)
    • PDF
    • AI
  • Refactor the monolithic ui/ui.coffee into smaller files
    • UI states
    • Mouse event routing
    • Tool management
  • Clean up hacks and rushed features
  • Pathfinder shape manipulation (union, subtraction, overlap)
  • More tools for manipulating bezier curvers
  • Guide lines, a more solid grid system
  • Responsive layout for smaller screens

However feel free to open Pull Requests dealing with any part of the app. It's a fun project in general.