Skip to content

Contributing

Vilius edited this page Oct 27, 2020 · 7 revisions

Looking to contribute something to miniPaint? Here's how you can help:

  • Code contributing - help add new features, fix bugs (see "Pull request" section)
  • Generate ideas - have idea how to improve it? Share it by creating new issue.
  • Test - use miniPaint, search for issues and report on issues section.
  • Use and enjoy - it's free, no download, no install, no purchases, no ads, no tracking.

Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before any significant pull request, otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Also please use tabs for code format.

Remember:

  • Do not edit dist/* directly! Those files are automatically generated.
  • Try not to edit src/js/core/* files if possible.

Contributing process:

  1. Fork the project & clone locally.
  2. If you cloned a while ago, get latest changes.
  3. Do the work, write good commit messages.
  4. Push to your origin repository.
  5. Create a new Pull Request in GitHub.
  6. Respond to any code review feedback.

Related: Extending system

Clone this wiki locally