Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (29 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 2.05 KB
Raw

Contributing to Wails

Thanks for your interest in contributing! Wails has two active tracks. Pick the one that matches the change you want to make.

v2 (stable)

  • Source: the v2/ directory on the master branch.
  • Docs: wails.io.
  • Detailed contributor guide: wails.io/community-guide.
  • Changelog: update website/src/pages/changelog.mdx under the [Unreleased] heading.

v3 (beta)

  • Source: the v3/ directory on the master branch.
  • Docs: v3.wails.io.
  • Detailed contributor guide: v3.wails.io/contributing.
  • Changelog: v3 entries are added automatically from your PR on merge. To control the wording, add your own entry to v3/UNRELEASED_CHANGELOG.md and the automation will use it instead.
  • New functionality and changes to public behaviour require a Wails Enhancement Proposal (WEP) before implementation. Open the WEP as a draft PR; do not open a feature-request issue. Ideas is available for optional early discussion.

Pull request checklist

  • One feature or fix per PR.
  • Update the relevant changelog file (see above).
  • Follow the existing coding style in the area you're touching.
  • Add tests where it makes sense.

Licence and provenance

Wails is released under the MIT Licence, and contributions come in under the same terms. By opening a pull request you confirm that:

  • You wrote the contribution yourself, or you have the right to submit it.
  • You are licensing it to the project under the MIT Licence.
  • Any third-party code included in it is compatibly licensed, and its origin and licence are stated in the pull request.

There is no CLA to sign and no sign-off trailer to add. If you are unsure whether something you want to include is safe to contribute, ask in the pull request before merging rather than after: sorting out the provenance of code that has already shipped is considerably harder than sorting it out up front.