Skip to content

Contributing

Vilius edited this page Dec 29, 2017 · 7 revisions

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

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.

Remember:

  • Do not edit dist/* directly! Those files are automatically generated.
  • Better do not 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.
Clone this wiki locally